{ "opencollection": "1.0.0", "info": { "name": "NetBox REST authentication-check ipam API", "version": "4.6.5 (4.6)" }, "items": [ { "info": { "name": "ipam", "type": "folder" }, "items": [ { "info": { "name": "ipam_aggregates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/aggregates/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact", "value": "", "type": "query", "description": "Contact" }, { "name": "contact__n", "value": "", "type": "query", "description": "Contact" }, { "name": "contact_group", "value": "", "type": "query" }, { "name": "contact_group__n", "value": "", "type": "query" }, { "name": "contact_role", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contact_role__n", "value": "", "type": "query", "description": "Contact Role" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "date_added", "value": "", "type": "query" }, { "name": "date_added__empty", "value": "", "type": "query" }, { "name": "date_added__gt", "value": "", "type": "query" }, { "name": "date_added__gte", "value": "", "type": "query" }, { "name": "date_added__lt", "value": "", "type": "query" }, { "name": "date_added__lte", "value": "", "type": "query" }, { "name": "date_added__n", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "family", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "prefix", "value": "", "type": "query", "description": "Prefix" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rir", "value": "", "type": "query", "description": "RIR (slug)" }, { "name": "rir__n", "value": "", "type": "query", "description": "RIR (slug)" }, { "name": "rir_id", "value": "", "type": "query", "description": "RIR (ID)" }, { "name": "rir_id__n", "value": "", "type": "query", "description": "RIR (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of aggregate objects." }, { "info": { "name": "ipam_aggregates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/aggregates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of aggregate objects." }, { "info": { "name": "ipam_aggregates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/aggregates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of aggregate objects." }, { "info": { "name": "ipam_aggregates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/aggregates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of aggregate objects." }, { "info": { "name": "ipam_aggregates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/aggregates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of aggregate objects." }, { "info": { "name": "ipam_aggregates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/aggregates/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this aggregate." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a aggregate object." }, { "info": { "name": "ipam_aggregates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/aggregates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this aggregate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a aggregate object." }, { "info": { "name": "ipam_aggregates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/aggregates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this aggregate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a aggregate object." }, { "info": { "name": "ipam_aggregates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/aggregates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this aggregate." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a aggregate object." }, { "info": { "name": "ipam_asn_ranges_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/asn-ranges/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query" }, { "name": "end__empty", "value": "", "type": "query" }, { "name": "end__gt", "value": "", "type": "query" }, { "name": "end__gte", "value": "", "type": "query" }, { "name": "end__lt", "value": "", "type": "query" }, { "name": "end__lte", "value": "", "type": "query" }, { "name": "end__n", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rir", "value": "", "type": "query", "description": "RIR (slug)" }, { "name": "rir__n", "value": "", "type": "query", "description": "RIR (slug)" }, { "name": "rir_id", "value": "", "type": "query", "description": "RIR (ID)" }, { "name": "rir_id__n", "value": "", "type": "query", "description": "RIR (ID)" }, { "name": "slug", "value": "", "type": "query" }, { "name": "slug__empty", "value": "", "type": "query" }, { "name": "slug__ic", "value": "", "type": "query" }, { "name": "slug__ie", "value": "", "type": "query" }, { "name": "slug__iew", "value": "", "type": "query" }, { "name": "slug__iregex", "value": "", "type": "query" }, { "name": "slug__isw", "value": "", "type": "query" }, { "name": "slug__n", "value": "", "type": "query" }, { "name": "slug__nic", "value": "", "type": "query" }, { "name": "slug__nie", "value": "", "type": "query" }, { "name": "slug__niew", "value": "", "type": "query" }, { "name": "slug__nisw", "value": "", "type": "query" }, { "name": "slug__regex", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "start__empty", "value": "", "type": "query" }, { "name": "start__gt", "value": "", "type": "query" }, { "name": "start__gte", "value": "", "type": "query" }, { "name": "start__lt", "value": "", "type": "query" }, { "name": "start__lte", "value": "", "type": "query" }, { "name": "start__n", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of ASN range objects." }, { "info": { "name": "ipam_asn_ranges_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/asn-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of ASN range objects." }, { "info": { "name": "ipam_asn_ranges_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/asn-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of ASN range objects." }, { "info": { "name": "ipam_asn_ranges_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/asn-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of ASN range objects." }, { "info": { "name": "ipam_asn_ranges_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/asn-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of ASN range objects." }, { "info": { "name": "ipam_asn_ranges_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/asn-ranges/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN range." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a ASN range object." }, { "info": { "name": "ipam_asn_ranges_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/asn-ranges/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN range." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a ASN range object." }, { "info": { "name": "ipam_asn_ranges_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/asn-ranges/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN range." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a ASN range object." }, { "info": { "name": "ipam_asn_ranges_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/asn-ranges/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN range." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a ASN range object." }, { "info": { "name": "ipam_asn_ranges_available_asns_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/asn-ranges/:id/available-asns/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path" }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a ASN object." }, { "info": { "name": "ipam_asn_ranges_available_asns_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/asn-ranges/:id/available-asns/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a ASN object." }, { "info": { "name": "ipam_asns_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/asns/", "params": [ { "name": "asn", "value": "", "type": "query" }, { "name": "asn__empty", "value": "", "type": "query" }, { "name": "asn__gt", "value": "", "type": "query" }, { "name": "asn__gte", "value": "", "type": "query" }, { "name": "asn__lt", "value": "", "type": "query" }, { "name": "asn__lte", "value": "", "type": "query" }, { "name": "asn__n", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "provider", "value": "", "type": "query", "description": "Provider (slug)" }, { "name": "provider__n", "value": "", "type": "query", "description": "Provider (slug)" }, { "name": "provider_id", "value": "", "type": "query", "description": "Provider (ID)" }, { "name": "provider_id__n", "value": "", "type": "query", "description": "Provider (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rir", "value": "", "type": "query", "description": "RIR (slug)" }, { "name": "rir__n", "value": "", "type": "query", "description": "RIR (slug)" }, { "name": "rir_id", "value": "", "type": "query", "description": "RIR (ID)" }, { "name": "rir_id__n", "value": "", "type": "query", "description": "RIR (ID)" }, { "name": "role", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role__n", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role_id", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "role_id__n", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "site", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site_group", "value": "", "type": "query" }, { "name": "site_group__n", "value": "", "type": "query" }, { "name": "site_group_id", "value": "", "type": "query" }, { "name": "site_group_id__n", "value": "", "type": "query" }, { "name": "site_id", "value": "", "type": "query", "description": "Site (ID)" }, { "name": "site_id__n", "value": "", "type": "query", "description": "Site (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of ASN objects." }, { "info": { "name": "ipam_asns_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/asns/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of ASN objects." }, { "info": { "name": "ipam_asns_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/asns/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of ASN objects." }, { "info": { "name": "ipam_asns_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/asns/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of ASN objects." }, { "info": { "name": "ipam_asns_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/asns/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of ASN objects." }, { "info": { "name": "ipam_asns_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/asns/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a ASN object." }, { "info": { "name": "ipam_asns_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/asns/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a ASN object." }, { "info": { "name": "ipam_asns_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/asns/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a ASN object." }, { "info": { "name": "ipam_asns_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/asns/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this ASN." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a ASN object." }, { "info": { "name": "ipam_fhrp_group_assignments_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/fhrp-group-assignments/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "device", "value": "", "type": "query" }, { "name": "device_id", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "group_id", "value": "", "type": "query", "description": "Group (ID)" }, { "name": "group_id__n", "value": "", "type": "query", "description": "Group (ID)" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "interface_id", "value": "", "type": "query" }, { "name": "interface_id__empty", "value": "", "type": "query" }, { "name": "interface_id__gt", "value": "", "type": "query" }, { "name": "interface_id__gte", "value": "", "type": "query" }, { "name": "interface_id__lt", "value": "", "type": "query" }, { "name": "interface_id__lte", "value": "", "type": "query" }, { "name": "interface_id__n", "value": "", "type": "query" }, { "name": "interface_type", "value": "", "type": "query" }, { "name": "interface_type__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "priority", "value": "", "type": "query" }, { "name": "priority__empty", "value": "", "type": "query" }, { "name": "priority__gt", "value": "", "type": "query" }, { "name": "priority__gte", "value": "", "type": "query" }, { "name": "priority__lt", "value": "", "type": "query" }, { "name": "priority__lte", "value": "", "type": "query" }, { "name": "priority__n", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_machine", "value": "", "type": "query" }, { "name": "virtual_machine_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of FHRP group assignment objects." }, { "info": { "name": "ipam_fhrp_group_assignments_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/fhrp-group-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of FHRP group assignment objects." }, { "info": { "name": "ipam_fhrp_group_assignments_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/fhrp-group-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of FHRP group assignment objects." }, { "info": { "name": "ipam_fhrp_group_assignments_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/fhrp-group-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of FHRP group assignment objects." }, { "info": { "name": "ipam_fhrp_group_assignments_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/fhrp-group-assignments/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of FHRP group assignment objects." }, { "info": { "name": "ipam_fhrp_group_assignments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/fhrp-group-assignments/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group assignment." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a FHRP group assignment object." }, { "info": { "name": "ipam_fhrp_group_assignments_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/fhrp-group-assignments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group assignment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a FHRP group assignment object." }, { "info": { "name": "ipam_fhrp_group_assignments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/fhrp-group-assignments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group assignment." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a FHRP group assignment object." }, { "info": { "name": "ipam_fhrp_group_assignments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/fhrp-group-assignments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group assignment." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a FHRP group assignment object." }, { "info": { "name": "ipam_fhrp_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/fhrp-groups/", "params": [ { "name": "auth_key", "value": "", "type": "query" }, { "name": "auth_key__empty", "value": "", "type": "query" }, { "name": "auth_key__ic", "value": "", "type": "query" }, { "name": "auth_key__ie", "value": "", "type": "query" }, { "name": "auth_key__iew", "value": "", "type": "query" }, { "name": "auth_key__iregex", "value": "", "type": "query" }, { "name": "auth_key__isw", "value": "", "type": "query" }, { "name": "auth_key__n", "value": "", "type": "query" }, { "name": "auth_key__nic", "value": "", "type": "query" }, { "name": "auth_key__nie", "value": "", "type": "query" }, { "name": "auth_key__niew", "value": "", "type": "query" }, { "name": "auth_key__nisw", "value": "", "type": "query" }, { "name": "auth_key__regex", "value": "", "type": "query" }, { "name": "auth_type", "value": "", "type": "query" }, { "name": "auth_type__empty", "value": "", "type": "query" }, { "name": "auth_type__ic", "value": "", "type": "query" }, { "name": "auth_type__ie", "value": "", "type": "query" }, { "name": "auth_type__iew", "value": "", "type": "query" }, { "name": "auth_type__iregex", "value": "", "type": "query" }, { "name": "auth_type__isw", "value": "", "type": "query" }, { "name": "auth_type__n", "value": "", "type": "query" }, { "name": "auth_type__nic", "value": "", "type": "query" }, { "name": "auth_type__nie", "value": "", "type": "query" }, { "name": "auth_type__niew", "value": "", "type": "query" }, { "name": "auth_type__nisw", "value": "", "type": "query" }, { "name": "auth_type__regex", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "group_id", "value": "", "type": "query" }, { "name": "group_id__empty", "value": "", "type": "query" }, { "name": "group_id__gt", "value": "", "type": "query" }, { "name": "group_id__gte", "value": "", "type": "query" }, { "name": "group_id__lt", "value": "", "type": "query" }, { "name": "group_id__lte", "value": "", "type": "query" }, { "name": "group_id__n", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "protocol", "value": "", "type": "query" }, { "name": "protocol__empty", "value": "", "type": "query" }, { "name": "protocol__ic", "value": "", "type": "query" }, { "name": "protocol__ie", "value": "", "type": "query" }, { "name": "protocol__iew", "value": "", "type": "query" }, { "name": "protocol__iregex", "value": "", "type": "query" }, { "name": "protocol__isw", "value": "", "type": "query" }, { "name": "protocol__n", "value": "", "type": "query" }, { "name": "protocol__nic", "value": "", "type": "query" }, { "name": "protocol__nie", "value": "", "type": "query" }, { "name": "protocol__niew", "value": "", "type": "query" }, { "name": "protocol__nisw", "value": "", "type": "query" }, { "name": "protocol__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "related_ip", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of FHRP group objects." }, { "info": { "name": "ipam_fhrp_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/fhrp-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of FHRP group objects." }, { "info": { "name": "ipam_fhrp_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/fhrp-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of FHRP group objects." }, { "info": { "name": "ipam_fhrp_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/fhrp-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of FHRP group objects." }, { "info": { "name": "ipam_fhrp_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/fhrp-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of FHRP group objects." }, { "info": { "name": "ipam_fhrp_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/fhrp-groups/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a FHRP group object." }, { "info": { "name": "ipam_fhrp_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/fhrp-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a FHRP group object." }, { "info": { "name": "ipam_fhrp_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/fhrp-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a FHRP group object." }, { "info": { "name": "ipam_fhrp_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/fhrp-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this FHRP group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a FHRP group object." }, { "info": { "name": "ipam_ip_addresses_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/ip-addresses/", "params": [ { "name": "address", "value": "", "type": "query" }, { "name": "assigned", "value": "", "type": "query", "description": "Is assigned" }, { "name": "assigned_object_id", "value": "", "type": "query" }, { "name": "assigned_object_id__empty", "value": "", "type": "query" }, { "name": "assigned_object_id__gt", "value": "", "type": "query" }, { "name": "assigned_object_id__gte", "value": "", "type": "query" }, { "name": "assigned_object_id__lt", "value": "", "type": "query" }, { "name": "assigned_object_id__lte", "value": "", "type": "query" }, { "name": "assigned_object_id__n", "value": "", "type": "query" }, { "name": "assigned_object_type", "value": "", "type": "query" }, { "name": "assigned_object_type__n", "value": "", "type": "query" }, { "name": "assigned_to_interface", "value": "", "type": "query", "description": "Is assigned to an interface" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact", "value": "", "type": "query", "description": "Contact" }, { "name": "contact__n", "value": "", "type": "query", "description": "Contact" }, { "name": "contact_group", "value": "", "type": "query" }, { "name": "contact_group__n", "value": "", "type": "query" }, { "name": "contact_role", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contact_role__n", "value": "", "type": "query", "description": "Contact Role" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "device", "value": "", "type": "query" }, { "name": "device_id", "value": "", "type": "query" }, { "name": "dns_name", "value": "", "type": "query" }, { "name": "dns_name__empty", "value": "", "type": "query" }, { "name": "dns_name__ic", "value": "", "type": "query" }, { "name": "dns_name__ie", "value": "", "type": "query" }, { "name": "dns_name__iew", "value": "", "type": "query" }, { "name": "dns_name__iregex", "value": "", "type": "query" }, { "name": "dns_name__isw", "value": "", "type": "query" }, { "name": "dns_name__n", "value": "", "type": "query" }, { "name": "dns_name__nic", "value": "", "type": "query" }, { "name": "dns_name__nie", "value": "", "type": "query" }, { "name": "dns_name__niew", "value": "", "type": "query" }, { "name": "dns_name__nisw", "value": "", "type": "query" }, { "name": "dns_name__regex", "value": "", "type": "query" }, { "name": "family", "value": "", "type": "query" }, { "name": "fhrpgroup_id", "value": "", "type": "query", "description": "FHRP group (ID)" }, { "name": "fhrpgroup_id__n", "value": "", "type": "query", "description": "FHRP group (ID)" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "interface", "value": "", "type": "query", "description": "Interface (name)" }, { "name": "interface__n", "value": "", "type": "query", "description": "Interface (name)" }, { "name": "interface_id", "value": "", "type": "query", "description": "Interface (ID)" }, { "name": "interface_id__n", "value": "", "type": "query", "description": "Interface (ID)" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "mask_length", "value": "", "type": "query" }, { "name": "mask_length__gte", "value": "", "type": "query" }, { "name": "mask_length__lte", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "nat_inside_id", "value": "", "type": "query", "description": "NAT inside IP address (ID)" }, { "name": "nat_inside_id__n", "value": "", "type": "query", "description": "NAT inside IP address (ID)" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "parent", "value": "", "type": "query" }, { "name": "present_in_vrf", "value": "", "type": "query" }, { "name": "present_in_vrf_id", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "role", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__empty", "value": "", "type": "query" }, { "name": "role__ic", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__ie", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__iew", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__iregex", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__isw", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__n", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__nic", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__nie", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__niew", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__nisw", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "role__regex", "value": "", "type": "query", "description": "The functional role of this IP" }, { "name": "service_id", "value": "", "type": "query", "description": "Application Service (ID)" }, { "name": "service_id__n", "value": "", "type": "query", "description": "Application Service (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "status", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__ie", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__iew", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__iregex", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__isw", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__n", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__nic", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__nie", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__niew", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__nisw", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "status__regex", "value": "", "type": "query", "description": "The operational status of this IP" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_machine", "value": "", "type": "query" }, { "name": "virtual_machine_id", "value": "", "type": "query" }, { "name": "vminterface", "value": "", "type": "query", "description": "VM interface (name)" }, { "name": "vminterface__n", "value": "", "type": "query", "description": "VM interface (name)" }, { "name": "vminterface_id", "value": "", "type": "query", "description": "VM interface (ID)" }, { "name": "vminterface_id__n", "value": "", "type": "query", "description": "VM interface (ID)" }, { "name": "vrf", "value": "", "type": "query", "description": "VRF (RD)" }, { "name": "vrf__n", "value": "", "type": "query", "description": "VRF (RD)" }, { "name": "vrf_id", "value": "", "type": "query", "description": "VRF" }, { "name": "vrf_id__n", "value": "", "type": "query", "description": "VRF" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of IP address objects." }, { "info": { "name": "ipam_ip_addresses_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/ip-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of IP address objects." }, { "info": { "name": "ipam_ip_addresses_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/ip-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of IP address objects." }, { "info": { "name": "ipam_ip_addresses_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/ip-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of IP address objects." }, { "info": { "name": "ipam_ip_addresses_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/ip-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of IP address objects." }, { "info": { "name": "ipam_ip_addresses_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/ip-addresses/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP address." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a IP address object." }, { "info": { "name": "ipam_ip_addresses_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/ip-addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP address." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a IP address object." }, { "info": { "name": "ipam_ip_addresses_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/ip-addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP address." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a IP address object." }, { "info": { "name": "ipam_ip_addresses_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/ip-addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP address." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a IP address object." }, { "info": { "name": "ipam_ip_ranges_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/ip-ranges/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact", "value": "", "type": "query", "description": "Contact" }, { "name": "contact__n", "value": "", "type": "query", "description": "Contact" }, { "name": "contact_group", "value": "", "type": "query" }, { "name": "contact_group__n", "value": "", "type": "query" }, { "name": "contact_role", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contact_role__n", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contains", "value": "", "type": "query", "description": "Ranges which contain this prefix or IP" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "end_address", "value": "", "type": "query" }, { "name": "family", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "mark_populated", "value": "", "type": "query" }, { "name": "mark_utilized", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "parent", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "role", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role__n", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role_id", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "role_id__n", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "size", "value": "", "type": "query" }, { "name": "size__empty", "value": "", "type": "query" }, { "name": "size__gt", "value": "", "type": "query" }, { "name": "size__gte", "value": "", "type": "query" }, { "name": "size__lt", "value": "", "type": "query" }, { "name": "size__lte", "value": "", "type": "query" }, { "name": "size__n", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "start_address", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__ie", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__iew", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__iregex", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__isw", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__n", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__nic", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__nie", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__niew", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__nisw", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "status__regex", "value": "", "type": "query", "description": "Operational status of this range" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "vrf", "value": "", "type": "query", "description": "VRF (RD)" }, { "name": "vrf__n", "value": "", "type": "query", "description": "VRF (RD)" }, { "name": "vrf_id", "value": "", "type": "query", "description": "VRF" }, { "name": "vrf_id__n", "value": "", "type": "query", "description": "VRF" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of IP range objects." }, { "info": { "name": "ipam_ip_ranges_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/ip-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of IP range objects." }, { "info": { "name": "ipam_ip_ranges_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/ip-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of IP range objects." }, { "info": { "name": "ipam_ip_ranges_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/ip-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of IP range objects." }, { "info": { "name": "ipam_ip_ranges_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/ip-ranges/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of IP range objects." }, { "info": { "name": "ipam_ip_ranges_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/ip-ranges/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP range." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a IP range object." }, { "info": { "name": "ipam_ip_ranges_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/ip-ranges/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP range." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a IP range object." }, { "info": { "name": "ipam_ip_ranges_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/ip-ranges/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP range." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a IP range object." }, { "info": { "name": "ipam_ip_ranges_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/ip-ranges/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this IP range." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a IP range object." }, { "info": { "name": "ipam_ip_ranges_available_ips_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/ip-ranges/:id/available-ips/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path" }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a IP address object." }, { "info": { "name": "ipam_ip_ranges_available_ips_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/ip-ranges/:id/available-ips/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a IP address object." }, { "info": { "name": "ipam_prefixes_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/prefixes/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "children", "value": "", "type": "query" }, { "name": "children__empty", "value": "", "type": "query" }, { "name": "children__gt", "value": "", "type": "query" }, { "name": "children__gte", "value": "", "type": "query" }, { "name": "children__lt", "value": "", "type": "query" }, { "name": "children__lte", "value": "", "type": "query" }, { "name": "children__n", "value": "", "type": "query" }, { "name": "contact", "value": "", "type": "query", "description": "Contact" }, { "name": "contact__n", "value": "", "type": "query", "description": "Contact" }, { "name": "contact_group", "value": "", "type": "query" }, { "name": "contact_group__n", "value": "", "type": "query" }, { "name": "contact_role", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contact_role__n", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contains", "value": "", "type": "query", "description": "Prefixes which contain this prefix or IP" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "depth", "value": "", "type": "query" }, { "name": "depth__empty", "value": "", "type": "query" }, { "name": "depth__gt", "value": "", "type": "query" }, { "name": "depth__gte", "value": "", "type": "query" }, { "name": "depth__lt", "value": "", "type": "query" }, { "name": "depth__lte", "value": "", "type": "query" }, { "name": "depth__n", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "family", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "is_pool", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "location", "value": "", "type": "query" }, { "name": "location__n", "value": "", "type": "query" }, { "name": "location_id", "value": "", "type": "query" }, { "name": "location_id__n", "value": "", "type": "query" }, { "name": "mark_utilized", "value": "", "type": "query" }, { "name": "mask_length", "value": "", "type": "query" }, { "name": "mask_length__gte", "value": "", "type": "query" }, { "name": "mask_length__lte", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "prefix", "value": "", "type": "query" }, { "name": "present_in_vrf", "value": "", "type": "query" }, { "name": "present_in_vrf_id", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "region", "value": "", "type": "query" }, { "name": "region__n", "value": "", "type": "query" }, { "name": "region_id", "value": "", "type": "query" }, { "name": "region_id__n", "value": "", "type": "query" }, { "name": "role", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role__n", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role_id", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "role_id__n", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "scope_id", "value": "", "type": "query" }, { "name": "scope_id__empty", "value": "", "type": "query" }, { "name": "scope_id__gt", "value": "", "type": "query" }, { "name": "scope_id__gte", "value": "", "type": "query" }, { "name": "scope_id__lt", "value": "", "type": "query" }, { "name": "scope_id__lte", "value": "", "type": "query" }, { "name": "scope_id__n", "value": "", "type": "query" }, { "name": "scope_type", "value": "", "type": "query" }, { "name": "scope_type__n", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site_group", "value": "", "type": "query" }, { "name": "site_group__n", "value": "", "type": "query" }, { "name": "site_group_id", "value": "", "type": "query" }, { "name": "site_group_id__n", "value": "", "type": "query" }, { "name": "site_id", "value": "", "type": "query", "description": "Site (ID)" }, { "name": "site_id__n", "value": "", "type": "query", "description": "Site (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "status", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__ie", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__iew", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__iregex", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__isw", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__n", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__nic", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__nie", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__niew", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__nisw", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "status__regex", "value": "", "type": "query", "description": "Operational status of this prefix" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "vlan_group", "value": "", "type": "query", "description": "VLAN Group (slug)" }, { "name": "vlan_group__n", "value": "", "type": "query", "description": "VLAN Group (slug)" }, { "name": "vlan_group_id", "value": "", "type": "query", "description": "VLAN Group (ID)" }, { "name": "vlan_group_id__n", "value": "", "type": "query", "description": "VLAN Group (ID)" }, { "name": "vlan_id", "value": "", "type": "query", "description": "VLAN (ID)" }, { "name": "vlan_id__n", "value": "", "type": "query", "description": "VLAN (ID)" }, { "name": "vlan_vid", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vlan_vid__empty", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vlan_vid__gt", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vlan_vid__gte", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vlan_vid__lt", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vlan_vid__lte", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vlan_vid__n", "value": "", "type": "query", "description": "VLAN number (1-4094)" }, { "name": "vrf", "value": "", "type": "query", "description": "VRF (RD)" }, { "name": "vrf__n", "value": "", "type": "query", "description": "VRF (RD)" }, { "name": "vrf_id", "value": "", "type": "query", "description": "VRF" }, { "name": "vrf_id__n", "value": "", "type": "query", "description": "VRF" }, { "name": "within", "value": "", "type": "query", "description": "Within prefix" }, { "name": "within_include", "value": "", "type": "query", "description": "Within and including prefix" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of prefix objects." }, { "info": { "name": "ipam_prefixes_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/prefixes/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of prefix objects." }, { "info": { "name": "ipam_prefixes_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/prefixes/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of prefix objects." }, { "info": { "name": "ipam_prefixes_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/prefixes/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of prefix objects." }, { "info": { "name": "ipam_prefixes_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/prefixes/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of prefix objects." }, { "info": { "name": "ipam_prefixes_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/prefixes/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this prefix." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a prefix object." }, { "info": { "name": "ipam_prefixes_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/prefixes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this prefix." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a prefix object." }, { "info": { "name": "ipam_prefixes_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/prefixes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this prefix." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a prefix object." }, { "info": { "name": "ipam_prefixes_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/prefixes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this prefix." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a prefix object." }, { "info": { "name": "ipam_prefixes_available_ips_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/prefixes/:id/available-ips/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path" }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a IP address object." }, { "info": { "name": "ipam_prefixes_available_ips_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/prefixes/:id/available-ips/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a IP address object." }, { "info": { "name": "ipam_prefixes_available_prefixes_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/prefixes/:id/available-prefixes/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path" }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a prefix object." }, { "info": { "name": "ipam_prefixes_available_prefixes_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/prefixes/:id/available-prefixes/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a prefix object." }, { "info": { "name": "ipam_rirs_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/rirs/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "is_private", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "slug", "value": "", "type": "query" }, { "name": "slug__empty", "value": "", "type": "query" }, { "name": "slug__ic", "value": "", "type": "query" }, { "name": "slug__ie", "value": "", "type": "query" }, { "name": "slug__iew", "value": "", "type": "query" }, { "name": "slug__iregex", "value": "", "type": "query" }, { "name": "slug__isw", "value": "", "type": "query" }, { "name": "slug__n", "value": "", "type": "query" }, { "name": "slug__nic", "value": "", "type": "query" }, { "name": "slug__nie", "value": "", "type": "query" }, { "name": "slug__niew", "value": "", "type": "query" }, { "name": "slug__nisw", "value": "", "type": "query" }, { "name": "slug__regex", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of RIR objects." }, { "info": { "name": "ipam_rirs_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/rirs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of RIR objects." }, { "info": { "name": "ipam_rirs_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/rirs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of RIR objects." }, { "info": { "name": "ipam_rirs_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/rirs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of RIR objects." }, { "info": { "name": "ipam_rirs_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/rirs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of RIR objects." }, { "info": { "name": "ipam_rirs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/rirs/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this RIR." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a RIR object." }, { "info": { "name": "ipam_rirs_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/rirs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this RIR." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a RIR object." }, { "info": { "name": "ipam_rirs_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/rirs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this RIR." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a RIR object." }, { "info": { "name": "ipam_rirs_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/rirs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this RIR." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a RIR object." }, { "info": { "name": "ipam_roles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/roles/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "slug", "value": "", "type": "query" }, { "name": "slug__empty", "value": "", "type": "query" }, { "name": "slug__ic", "value": "", "type": "query" }, { "name": "slug__ie", "value": "", "type": "query" }, { "name": "slug__iew", "value": "", "type": "query" }, { "name": "slug__iregex", "value": "", "type": "query" }, { "name": "slug__isw", "value": "", "type": "query" }, { "name": "slug__n", "value": "", "type": "query" }, { "name": "slug__nic", "value": "", "type": "query" }, { "name": "slug__nie", "value": "", "type": "query" }, { "name": "slug__niew", "value": "", "type": "query" }, { "name": "slug__nisw", "value": "", "type": "query" }, { "name": "slug__regex", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "weight", "value": "", "type": "query" }, { "name": "weight__empty", "value": "", "type": "query" }, { "name": "weight__gt", "value": "", "type": "query" }, { "name": "weight__gte", "value": "", "type": "query" }, { "name": "weight__lt", "value": "", "type": "query" }, { "name": "weight__lte", "value": "", "type": "query" }, { "name": "weight__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of role objects." }, { "info": { "name": "ipam_roles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of role objects." }, { "info": { "name": "ipam_roles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of role objects." }, { "info": { "name": "ipam_roles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of role objects." }, { "info": { "name": "ipam_roles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of role objects." }, { "info": { "name": "ipam_roles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/roles/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this role." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a role object." }, { "info": { "name": "ipam_roles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a role object." }, { "info": { "name": "ipam_roles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a role object." }, { "info": { "name": "ipam_roles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this role." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a role object." }, { "info": { "name": "ipam_route_targets_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/route-targets/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "exporting_l2vpn", "value": "", "type": "query", "description": "Exporting L2VPN (identifier)" }, { "name": "exporting_l2vpn__n", "value": "", "type": "query", "description": "Exporting L2VPN (identifier)" }, { "name": "exporting_l2vpn_id", "value": "", "type": "query", "description": "Exporting L2VPN" }, { "name": "exporting_l2vpn_id__n", "value": "", "type": "query", "description": "Exporting L2VPN" }, { "name": "exporting_vrf", "value": "", "type": "query", "description": "Export VRF (RD)" }, { "name": "exporting_vrf__n", "value": "", "type": "query", "description": "Export VRF (RD)" }, { "name": "exporting_vrf_id", "value": "", "type": "query", "description": "Exporting VRF" }, { "name": "exporting_vrf_id__n", "value": "", "type": "query", "description": "Exporting VRF" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "importing_l2vpn", "value": "", "type": "query", "description": "Importing L2VPN (identifier)" }, { "name": "importing_l2vpn__n", "value": "", "type": "query", "description": "Importing L2VPN (identifier)" }, { "name": "importing_l2vpn_id", "value": "", "type": "query", "description": "Importing L2VPN" }, { "name": "importing_l2vpn_id__n", "value": "", "type": "query", "description": "Importing L2VPN" }, { "name": "importing_vrf", "value": "", "type": "query", "description": "Import VRF (RD)" }, { "name": "importing_vrf__n", "value": "", "type": "query", "description": "Import VRF (RD)" }, { "name": "importing_vrf_id", "value": "", "type": "query", "description": "Importing VRF" }, { "name": "importing_vrf_id__n", "value": "", "type": "query", "description": "Importing VRF" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of route target objects." }, { "info": { "name": "ipam_route_targets_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/route-targets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of route target objects." }, { "info": { "name": "ipam_route_targets_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/route-targets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of route target objects." }, { "info": { "name": "ipam_route_targets_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/route-targets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of route target objects." }, { "info": { "name": "ipam_route_targets_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/route-targets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of route target objects." }, { "info": { "name": "ipam_route_targets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/route-targets/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this route target." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a route target object." }, { "info": { "name": "ipam_route_targets_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/route-targets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this route target." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a route target object." }, { "info": { "name": "ipam_route_targets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/route-targets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this route target." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a route target object." }, { "info": { "name": "ipam_route_targets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/route-targets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this route target." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a route target object." }, { "info": { "name": "ipam_service_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/service-templates/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "port", "value": "", "type": "query" }, { "name": "port__empty", "value": "", "type": "query" }, { "name": "port__gt", "value": "", "type": "query" }, { "name": "port__gte", "value": "", "type": "query" }, { "name": "port__lt", "value": "", "type": "query" }, { "name": "port__lte", "value": "", "type": "query" }, { "name": "port__n", "value": "", "type": "query" }, { "name": "protocol", "value": "", "type": "query", "description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP" }, { "name": "protocol__empty", "value": "", "type": "query" }, { "name": "protocol__ic", "value": "", "type": "query" }, { "name": "protocol__ie", "value": "", "type": "query" }, { "name": "protocol__iew", "value": "", "type": "query" }, { "name": "protocol__iregex", "value": "", "type": "query" }, { "name": "protocol__isw", "value": "", "type": "query" }, { "name": "protocol__n", "value": "", "type": "query", "description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP" }, { "name": "protocol__nic", "value": "", "type": "query" }, { "name": "protocol__nie", "value": "", "type": "query" }, { "name": "protocol__niew", "value": "", "type": "query" }, { "name": "protocol__nisw", "value": "", "type": "query" }, { "name": "protocol__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of application service template objects." }, { "info": { "name": "ipam_service_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/service-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of application service template objects." }, { "info": { "name": "ipam_service_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/service-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of application service template objects." }, { "info": { "name": "ipam_service_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/service-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of application service template objects." }, { "info": { "name": "ipam_service_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/service-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of application service template objects." }, { "info": { "name": "ipam_service_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/service-templates/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service template." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a application service template object." }, { "info": { "name": "ipam_service_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/service-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a application service template object." }, { "info": { "name": "ipam_service_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/service-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a application service template object." }, { "info": { "name": "ipam_service_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/service-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a application service template object." }, { "info": { "name": "ipam_services_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/services/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "contact", "value": "", "type": "query", "description": "Contact" }, { "name": "contact__n", "value": "", "type": "query", "description": "Contact" }, { "name": "contact_group", "value": "", "type": "query" }, { "name": "contact_group__n", "value": "", "type": "query" }, { "name": "contact_role", "value": "", "type": "query", "description": "Contact Role" }, { "name": "contact_role__n", "value": "", "type": "query", "description": "Contact Role" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "device", "value": "", "type": "query" }, { "name": "device_id", "value": "", "type": "query" }, { "name": "fhrpgroup", "value": "", "type": "query" }, { "name": "fhrpgroup_id", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "ip_address", "value": "", "type": "query", "description": "IP address" }, { "name": "ip_address__n", "value": "", "type": "query", "description": "IP address" }, { "name": "ip_address_id", "value": "", "type": "query", "description": "IP address (ID)" }, { "name": "ip_address_id__n", "value": "", "type": "query", "description": "IP address (ID)" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "parent_object_id", "value": "", "type": "query" }, { "name": "parent_object_id__empty", "value": "", "type": "query" }, { "name": "parent_object_id__gt", "value": "", "type": "query" }, { "name": "parent_object_id__gte", "value": "", "type": "query" }, { "name": "parent_object_id__lt", "value": "", "type": "query" }, { "name": "parent_object_id__lte", "value": "", "type": "query" }, { "name": "parent_object_id__n", "value": "", "type": "query" }, { "name": "parent_object_type", "value": "", "type": "query" }, { "name": "parent_object_type__n", "value": "", "type": "query" }, { "name": "port", "value": "", "type": "query" }, { "name": "port__empty", "value": "", "type": "query" }, { "name": "port__gt", "value": "", "type": "query" }, { "name": "port__gte", "value": "", "type": "query" }, { "name": "port__lt", "value": "", "type": "query" }, { "name": "port__lte", "value": "", "type": "query" }, { "name": "port__n", "value": "", "type": "query" }, { "name": "protocol", "value": "", "type": "query", "description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP" }, { "name": "protocol__empty", "value": "", "type": "query" }, { "name": "protocol__ic", "value": "", "type": "query" }, { "name": "protocol__ie", "value": "", "type": "query" }, { "name": "protocol__iew", "value": "", "type": "query" }, { "name": "protocol__iregex", "value": "", "type": "query" }, { "name": "protocol__isw", "value": "", "type": "query" }, { "name": "protocol__n", "value": "", "type": "query", "description": "* `tcp` - TCP\n* `udp` - UDP\n* `sctp` - SCTP" }, { "name": "protocol__nic", "value": "", "type": "query" }, { "name": "protocol__nie", "value": "", "type": "query" }, { "name": "protocol__niew", "value": "", "type": "query" }, { "name": "protocol__nisw", "value": "", "type": "query" }, { "name": "protocol__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_machine", "value": "", "type": "query" }, { "name": "virtual_machine_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of application service objects." }, { "info": { "name": "ipam_services_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/services/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of application service objects." }, { "info": { "name": "ipam_services_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/services/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of application service objects." }, { "info": { "name": "ipam_services_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/services/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of application service objects." }, { "info": { "name": "ipam_services_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/services/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of application service objects." }, { "info": { "name": "ipam_services_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/services/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a application service object." }, { "info": { "name": "ipam_services_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/services/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a application service object." }, { "info": { "name": "ipam_services_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/services/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a application service object." }, { "info": { "name": "ipam_services_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/services/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this application service." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a application service object." }, { "info": { "name": "ipam_vlan_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-groups/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cluster", "value": "", "type": "query" }, { "name": "cluster_group", "value": "", "type": "query" }, { "name": "contains_vid", "value": "", "type": "query" }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "location", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query" }, { "name": "rack_group", "value": "", "type": "query" }, { "name": "region", "value": "", "type": "query" }, { "name": "scope_id", "value": "", "type": "query" }, { "name": "scope_id__empty", "value": "", "type": "query" }, { "name": "scope_id__gt", "value": "", "type": "query" }, { "name": "scope_id__gte", "value": "", "type": "query" }, { "name": "scope_id__lt", "value": "", "type": "query" }, { "name": "scope_id__lte", "value": "", "type": "query" }, { "name": "scope_id__n", "value": "", "type": "query" }, { "name": "scope_type", "value": "", "type": "query" }, { "name": "scope_type__n", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query" }, { "name": "site_group", "value": "", "type": "query" }, { "name": "slug", "value": "", "type": "query" }, { "name": "slug__empty", "value": "", "type": "query" }, { "name": "slug__ic", "value": "", "type": "query" }, { "name": "slug__ie", "value": "", "type": "query" }, { "name": "slug__iew", "value": "", "type": "query" }, { "name": "slug__iregex", "value": "", "type": "query" }, { "name": "slug__isw", "value": "", "type": "query" }, { "name": "slug__n", "value": "", "type": "query" }, { "name": "slug__nic", "value": "", "type": "query" }, { "name": "slug__nie", "value": "", "type": "query" }, { "name": "slug__niew", "value": "", "type": "query" }, { "name": "slug__nisw", "value": "", "type": "query" }, { "name": "slug__regex", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "total_vlan_ids", "value": "", "type": "query" }, { "name": "total_vlan_ids__empty", "value": "", "type": "query" }, { "name": "total_vlan_ids__gt", "value": "", "type": "query" }, { "name": "total_vlan_ids__gte", "value": "", "type": "query" }, { "name": "total_vlan_ids__lt", "value": "", "type": "query" }, { "name": "total_vlan_ids__lte", "value": "", "type": "query" }, { "name": "total_vlan_ids__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of VLAN group objects." }, { "info": { "name": "ipam_vlan_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/vlan-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of VLAN group objects." }, { "info": { "name": "ipam_vlan_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlan-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of VLAN group objects." }, { "info": { "name": "ipam_vlan_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlan-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of VLAN group objects." }, { "info": { "name": "ipam_vlan_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlan-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of VLAN group objects." }, { "info": { "name": "ipam_vlan_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-groups/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN group." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a VLAN group object." }, { "info": { "name": "ipam_vlan_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlan-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a VLAN group object." }, { "info": { "name": "ipam_vlan_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlan-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a VLAN group object." }, { "info": { "name": "ipam_vlan_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlan-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a VLAN group object." }, { "info": { "name": "ipam_vlan_groups_available_vlans_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-groups/:id/available-vlans/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path" }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a VLAN object." }, { "info": { "name": "ipam_vlan_groups_available_vlans_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/vlan-groups/:id/available-vlans/", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a VLAN object." }, { "info": { "name": "ipam_vlan_translation_policies_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-translation-policies/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of VLAN translation policy objects." }, { "info": { "name": "ipam_vlan_translation_policies_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/vlan-translation-policies/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of VLAN translation policy objects." }, { "info": { "name": "ipam_vlan_translation_policies_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlan-translation-policies/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of VLAN translation policy objects." }, { "info": { "name": "ipam_vlan_translation_policies_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlan-translation-policies/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of VLAN translation policy objects." }, { "info": { "name": "ipam_vlan_translation_policies_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlan-translation-policies/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of VLAN translation policy objects." }, { "info": { "name": "ipam_vlan_translation_policies_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-translation-policies/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation policy." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a VLAN translation policy object." }, { "info": { "name": "ipam_vlan_translation_policies_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlan-translation-policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation policy." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a VLAN translation policy object." }, { "info": { "name": "ipam_vlan_translation_policies_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlan-translation-policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation policy." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a VLAN translation policy object." }, { "info": { "name": "ipam_vlan_translation_policies_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlan-translation-policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation policy." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a VLAN translation policy object." }, { "info": { "name": "ipam_vlan_translation_rules_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-translation-rules/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "local_vid", "value": "", "type": "query" }, { "name": "local_vid__empty", "value": "", "type": "query" }, { "name": "local_vid__gt", "value": "", "type": "query" }, { "name": "local_vid__gte", "value": "", "type": "query" }, { "name": "local_vid__lt", "value": "", "type": "query" }, { "name": "local_vid__lte", "value": "", "type": "query" }, { "name": "local_vid__n", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "policy", "value": "", "type": "query", "description": "VLAN Translation Policy (name)" }, { "name": "policy__n", "value": "", "type": "query", "description": "VLAN Translation Policy (name)" }, { "name": "policy_id", "value": "", "type": "query", "description": "VLAN Translation Policy (ID)" }, { "name": "policy_id__n", "value": "", "type": "query", "description": "VLAN Translation Policy (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "remote_vid", "value": "", "type": "query" }, { "name": "remote_vid__empty", "value": "", "type": "query" }, { "name": "remote_vid__gt", "value": "", "type": "query" }, { "name": "remote_vid__gte", "value": "", "type": "query" }, { "name": "remote_vid__lt", "value": "", "type": "query" }, { "name": "remote_vid__lte", "value": "", "type": "query" }, { "name": "remote_vid__n", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of VLAN translation rule objects." }, { "info": { "name": "ipam_vlan_translation_rules_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/vlan-translation-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of VLAN translation rule objects." }, { "info": { "name": "ipam_vlan_translation_rules_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlan-translation-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of VLAN translation rule objects." }, { "info": { "name": "ipam_vlan_translation_rules_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlan-translation-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of VLAN translation rule objects." }, { "info": { "name": "ipam_vlan_translation_rules_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlan-translation-rules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of VLAN translation rule objects." }, { "info": { "name": "ipam_vlan_translation_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlan-translation-rules/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation rule." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a VLAN translation rule object." }, { "info": { "name": "ipam_vlan_translation_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlan-translation-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a VLAN translation rule object." }, { "info": { "name": "ipam_vlan_translation_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlan-translation-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a VLAN translation rule object." }, { "info": { "name": "ipam_vlan_translation_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlan-translation-rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN translation rule." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a VLAN translation rule object." }, { "info": { "name": "ipam_vlans_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlans/", "params": [ { "name": "available_at_site", "value": "", "type": "query" }, { "name": "available_on_device", "value": "", "type": "query" }, { "name": "available_on_virtualmachine", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "group", "value": "", "type": "query", "description": "Group" }, { "name": "group__n", "value": "", "type": "query", "description": "Group" }, { "name": "group_id", "value": "", "type": "query", "description": "Group (ID)" }, { "name": "group_id__n", "value": "", "type": "query", "description": "Group (ID)" }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "interface_id", "value": "", "type": "query" }, { "name": "l2vpn", "value": "", "type": "query", "description": "L2VPN" }, { "name": "l2vpn__n", "value": "", "type": "query", "description": "L2VPN" }, { "name": "l2vpn_id", "value": "", "type": "query", "description": "L2VPN (ID)" }, { "name": "l2vpn_id__n", "value": "", "type": "query", "description": "L2VPN (ID)" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "qinq_role", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__empty", "value": "", "type": "query" }, { "name": "qinq_role__ic", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__ie", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__iew", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__iregex", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__isw", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__n", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__nic", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__nie", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__niew", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__nisw", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_role__regex", "value": "", "type": "query", "description": "Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad)" }, { "name": "qinq_svlan_id", "value": "", "type": "query", "description": "Q-in-Q SVLAN (ID)" }, { "name": "qinq_svlan_id__n", "value": "", "type": "query", "description": "Q-in-Q SVLAN (ID)" }, { "name": "qinq_svlan_vid", "value": "", "type": "query" }, { "name": "qinq_svlan_vid__empty", "value": "", "type": "query" }, { "name": "qinq_svlan_vid__gt", "value": "", "type": "query" }, { "name": "qinq_svlan_vid__gte", "value": "", "type": "query" }, { "name": "qinq_svlan_vid__lt", "value": "", "type": "query" }, { "name": "qinq_svlan_vid__lte", "value": "", "type": "query" }, { "name": "qinq_svlan_vid__n", "value": "", "type": "query" }, { "name": "region", "value": "", "type": "query" }, { "name": "region__n", "value": "", "type": "query" }, { "name": "region_id", "value": "", "type": "query" }, { "name": "region_id__n", "value": "", "type": "query" }, { "name": "role", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role__n", "value": "", "type": "query", "description": "Role (slug)" }, { "name": "role_id", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "role_id__n", "value": "", "type": "query", "description": "Role (ID)" }, { "name": "site", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site (slug)" }, { "name": "site_group", "value": "", "type": "query" }, { "name": "site_group__n", "value": "", "type": "query" }, { "name": "site_group_id", "value": "", "type": "query" }, { "name": "site_group_id__n", "value": "", "type": "query" }, { "name": "site_id", "value": "", "type": "query", "description": "Site (ID)" }, { "name": "site_id__n", "value": "", "type": "query", "description": "Site (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "status", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__ie", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__iew", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__iregex", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__isw", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__n", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__nic", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__nie", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__niew", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__nisw", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "status__regex", "value": "", "type": "query", "description": "Operational status of this VLAN" }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "vid", "value": "", "type": "query" }, { "name": "vid__empty", "value": "", "type": "query" }, { "name": "vid__gt", "value": "", "type": "query" }, { "name": "vid__gte", "value": "", "type": "query" }, { "name": "vid__lt", "value": "", "type": "query" }, { "name": "vid__lte", "value": "", "type": "query" }, { "name": "vid__n", "value": "", "type": "query" }, { "name": "vminterface_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of VLAN objects." }, { "info": { "name": "ipam_vlans_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/vlans/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of VLAN objects." }, { "info": { "name": "ipam_vlans_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlans/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of VLAN objects." }, { "info": { "name": "ipam_vlans_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlans/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of VLAN objects." }, { "info": { "name": "ipam_vlans_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlans/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of VLAN objects." }, { "info": { "name": "ipam_vlans_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vlans/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a VLAN object." }, { "info": { "name": "ipam_vlans_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vlans/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a VLAN object." }, { "info": { "name": "ipam_vlans_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vlans/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a VLAN object." }, { "info": { "name": "ipam_vlans_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vlans/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VLAN." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a VLAN object." }, { "info": { "name": "ipam_vrfs_list", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vrfs/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "created", "value": "", "type": "query" }, { "name": "created__empty", "value": "", "type": "query" }, { "name": "created__gt", "value": "", "type": "query" }, { "name": "created__gte", "value": "", "type": "query" }, { "name": "created__lt", "value": "", "type": "query" }, { "name": "created__lte", "value": "", "type": "query" }, { "name": "created__n", "value": "", "type": "query" }, { "name": "created_by_request", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "description__empty", "value": "", "type": "query" }, { "name": "description__ic", "value": "", "type": "query" }, { "name": "description__ie", "value": "", "type": "query" }, { "name": "description__iew", "value": "", "type": "query" }, { "name": "description__iregex", "value": "", "type": "query" }, { "name": "description__isw", "value": "", "type": "query" }, { "name": "description__n", "value": "", "type": "query" }, { "name": "description__nic", "value": "", "type": "query" }, { "name": "description__nie", "value": "", "type": "query" }, { "name": "description__niew", "value": "", "type": "query" }, { "name": "description__nisw", "value": "", "type": "query" }, { "name": "description__regex", "value": "", "type": "query" }, { "name": "enforce_unique", "value": "", "type": "query" }, { "name": "export_target", "value": "", "type": "query", "description": "Export target (name)" }, { "name": "export_target__n", "value": "", "type": "query", "description": "Export target (name)" }, { "name": "export_target_id", "value": "", "type": "query", "description": "Export target" }, { "name": "export_target_id__n", "value": "", "type": "query", "description": "Export target" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "query" }, { "name": "id__empty", "value": "", "type": "query" }, { "name": "id__gt", "value": "", "type": "query" }, { "name": "id__gte", "value": "", "type": "query" }, { "name": "id__lt", "value": "", "type": "query" }, { "name": "id__lte", "value": "", "type": "query" }, { "name": "id__n", "value": "", "type": "query" }, { "name": "import_target", "value": "", "type": "query", "description": "Import target (name)" }, { "name": "import_target__n", "value": "", "type": "query", "description": "Import target (name)" }, { "name": "import_target_id", "value": "", "type": "query", "description": "Import target" }, { "name": "import_target_id__n", "value": "", "type": "query", "description": "Import target" }, { "name": "last_updated", "value": "", "type": "query" }, { "name": "last_updated__empty", "value": "", "type": "query" }, { "name": "last_updated__gt", "value": "", "type": "query" }, { "name": "last_updated__gte", "value": "", "type": "query" }, { "name": "last_updated__lt", "value": "", "type": "query" }, { "name": "last_updated__lte", "value": "", "type": "query" }, { "name": "last_updated__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "name", "value": "", "type": "query" }, { "name": "name__empty", "value": "", "type": "query" }, { "name": "name__ic", "value": "", "type": "query" }, { "name": "name__ie", "value": "", "type": "query" }, { "name": "name__iew", "value": "", "type": "query" }, { "name": "name__iregex", "value": "", "type": "query" }, { "name": "name__isw", "value": "", "type": "query" }, { "name": "name__n", "value": "", "type": "query" }, { "name": "name__nic", "value": "", "type": "query" }, { "name": "name__nie", "value": "", "type": "query" }, { "name": "name__niew", "value": "", "type": "query" }, { "name": "name__nisw", "value": "", "type": "query" }, { "name": "name__regex", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "owner", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner__n", "value": "", "type": "query", "description": "Owner (name)" }, { "name": "owner_group", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group__n", "value": "", "type": "query", "description": "Owner Group (name)" }, { "name": "owner_group_id", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_group_id__n", "value": "", "type": "query", "description": "Owner Group (ID)" }, { "name": "owner_id", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "owner_id__n", "value": "", "type": "query", "description": "Owner (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rd", "value": "", "type": "query" }, { "name": "rd__empty", "value": "", "type": "query" }, { "name": "rd__ic", "value": "", "type": "query" }, { "name": "rd__ie", "value": "", "type": "query" }, { "name": "rd__iew", "value": "", "type": "query" }, { "name": "rd__iregex", "value": "", "type": "query" }, { "name": "rd__isw", "value": "", "type": "query" }, { "name": "rd__n", "value": "", "type": "query" }, { "name": "rd__nic", "value": "", "type": "query" }, { "name": "rd__nie", "value": "", "type": "query" }, { "name": "rd__niew", "value": "", "type": "query" }, { "name": "rd__nisw", "value": "", "type": "query" }, { "name": "rd__regex", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "tag", "value": "", "type": "query" }, { "name": "tag__n", "value": "", "type": "query" }, { "name": "tag_id", "value": "", "type": "query" }, { "name": "tag_id__n", "value": "", "type": "query" }, { "name": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_group", "value": "", "type": "query" }, { "name": "tenant_group__n", "value": "", "type": "query" }, { "name": "tenant_group_id", "value": "", "type": "query" }, { "name": "tenant_group_id__n", "value": "", "type": "query" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of VRF objects." }, { "info": { "name": "ipam_vrfs_create", "type": "http" }, "http": { "method": "POST", "url": "/api/ipam/vrfs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of VRF objects." }, { "info": { "name": "ipam_vrfs_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vrfs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of VRF objects." }, { "info": { "name": "ipam_vrfs_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vrfs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of VRF objects." }, { "info": { "name": "ipam_vrfs_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vrfs/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of VRF objects." }, { "info": { "name": "ipam_vrfs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/ipam/vrfs/:id/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VRF." }, { "name": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a VRF object." }, { "info": { "name": "ipam_vrfs_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/ipam/vrfs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VRF." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a VRF object." }, { "info": { "name": "ipam_vrfs_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/ipam/vrfs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VRF." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a VRF object." }, { "info": { "name": "ipam_vrfs_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/ipam/vrfs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this VRF." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a VRF object." } ] } ], "bundled": true }