{ "opencollection": "1.0.0", "info": { "name": "NetBox REST authentication-check dcim API", "version": "4.6.5 (4.6)" }, "items": [ { "info": { "name": "dcim", "type": "folder" }, "items": [ { "info": { "name": "dcim_cable_bundles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/cable-bundles/", "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 cable bundle objects." }, { "info": { "name": "dcim_cable_bundles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/cable-bundles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of cable bundle objects." }, { "info": { "name": "dcim_cable_bundles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/cable-bundles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of cable bundle objects." }, { "info": { "name": "dcim_cable_bundles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/cable-bundles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of cable bundle objects." }, { "info": { "name": "dcim_cable_bundles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/cable-bundles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of cable bundle objects." }, { "info": { "name": "dcim_cable_bundles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/cable-bundles/: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 cable bundle." }, { "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 cable bundle object." }, { "info": { "name": "dcim_cable_bundles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/cable-bundles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cable bundle." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a cable bundle object." }, { "info": { "name": "dcim_cable_bundles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/cable-bundles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cable bundle." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a cable bundle object." }, { "info": { "name": "dcim_cable_bundles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/cable-bundles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cable bundle." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a cable bundle object." }, { "info": { "name": "dcim_cable_terminations_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/cable-terminations/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable", "value": "", "type": "query" }, { "name": "cable__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "circuittermination_id", "value": "", "type": "query" }, { "name": "consoleport_id", "value": "", "type": "query" }, { "name": "consoleserverport_id", "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": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "frontport_id", "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": "interface_id", "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": "powerfeed_id", "value": "", "type": "query" }, { "name": "poweroutlet_id", "value": "", "type": "query" }, { "name": "powerport_id", "value": "", "type": "query" }, { "name": "rearport_id", "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": "termination_id", "value": "", "type": "query" }, { "name": "termination_id__empty", "value": "", "type": "query" }, { "name": "termination_id__gt", "value": "", "type": "query" }, { "name": "termination_id__gte", "value": "", "type": "query" }, { "name": "termination_id__lt", "value": "", "type": "query" }, { "name": "termination_id__lte", "value": "", "type": "query" }, { "name": "termination_id__n", "value": "", "type": "query" }, { "name": "termination_type", "value": "", "type": "query" }, { "name": "termination_type__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 cable termination objects." }, { "info": { "name": "dcim_cable_terminations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/cable-terminations/: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 cable termination." }, { "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 cable termination object." }, { "info": { "name": "dcim_cables_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/cables/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "bundle", "value": "", "type": "query", "description": "Cable bundle (name)" }, { "name": "bundle__n", "value": "", "type": "query", "description": "Cable bundle (name)" }, { "name": "bundle_id", "value": "", "type": "query", "description": "Cable bundle (ID)" }, { "name": "bundle_id__n", "value": "", "type": "query", "description": "Cable bundle (ID)" }, { "name": "circuittermination_id", "value": "", "type": "query" }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "value": "", "type": "query" }, { "name": "consoleport_id", "value": "", "type": "query" }, { "name": "consoleserverport_id", "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": "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": "frontport_id", "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": "interface_id", "value": "", "type": "query" }, { "name": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "length", "value": "", "type": "query" }, { "name": "length__empty", "value": "", "type": "query" }, { "name": "length__gt", "value": "", "type": "query" }, { "name": "length__gte", "value": "", "type": "query" }, { "name": "length__lt", "value": "", "type": "query" }, { "name": "length__lte", "value": "", "type": "query" }, { "name": "length__n", "value": "", "type": "query" }, { "name": "length_unit", "value": "", "type": "query", "description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches" }, { "name": "length_unit__empty", "value": "", "type": "query" }, { "name": "length_unit__ic", "value": "", "type": "query" }, { "name": "length_unit__ie", "value": "", "type": "query" }, { "name": "length_unit__iew", "value": "", "type": "query" }, { "name": "length_unit__iregex", "value": "", "type": "query" }, { "name": "length_unit__isw", "value": "", "type": "query" }, { "name": "length_unit__n", "value": "", "type": "query", "description": "* `km` - Kilometers\n* `m` - Meters\n* `cm` - Centimeters\n* `mi` - Miles\n* `ft` - Feet\n* `in` - Inches" }, { "name": "length_unit__nic", "value": "", "type": "query" }, { "name": "length_unit__nie", "value": "", "type": "query" }, { "name": "length_unit__niew", "value": "", "type": "query" }, { "name": "length_unit__nisw", "value": "", "type": "query" }, { "name": "length_unit__regex", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "location", "value": "", "type": "query" }, { "name": "location_id", "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": "powerfeed_id", "value": "", "type": "query" }, { "name": "poweroutlet_id", "value": "", "type": "query" }, { "name": "powerport_id", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "profile__empty", "value": "", "type": "query" }, { "name": "profile__ic", "value": "", "type": "query" }, { "name": "profile__ie", "value": "", "type": "query" }, { "name": "profile__iew", "value": "", "type": "query" }, { "name": "profile__iregex", "value": "", "type": "query" }, { "name": "profile__isw", "value": "", "type": "query" }, { "name": "profile__n", "value": "", "type": "query" }, { "name": "profile__nic", "value": "", "type": "query" }, { "name": "profile__nie", "value": "", "type": "query" }, { "name": "profile__niew", "value": "", "type": "query" }, { "name": "profile__nisw", "value": "", "type": "query" }, { "name": "profile__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query" }, { "name": "rack_id", "value": "", "type": "query" }, { "name": "rearport_id", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query" }, { "name": "site_id", "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": "status", "value": "", "type": "query" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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": "termination_a_id", "value": "", "type": "query" }, { "name": "termination_a_type", "value": "", "type": "query" }, { "name": "termination_a_type__n", "value": "", "type": "query" }, { "name": "termination_b_id", "value": "", "type": "query" }, { "name": "termination_b_type", "value": "", "type": "query" }, { "name": "termination_b_type__n", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "unterminated", "value": "", "type": "query", "description": "Unterminated" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of cable objects." }, { "info": { "name": "dcim_cables_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/cables/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of cable objects." }, { "info": { "name": "dcim_cables_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/cables/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of cable objects." }, { "info": { "name": "dcim_cables_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/cables/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of cable objects." }, { "info": { "name": "dcim_cables_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/cables/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of cable objects." }, { "info": { "name": "dcim_cables_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/cables/: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 cable." }, { "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 cable object." }, { "info": { "name": "dcim_cables_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/cables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a cable object." }, { "info": { "name": "dcim_cables_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/cables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a cable object." }, { "info": { "name": "dcim_cables_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/cables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cable." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a cable object." }, { "info": { "name": "dcim_connected_device_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/connected-device/", "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": "omit", "value": "", "type": "query", "description": "Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`." }, { "name": "peer_device", "value": "", "type": "query", "description": "The name of the peer device" }, { "name": "peer_interface", "value": "", "type": "query", "description": "The name of the peer interface" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer\ninterface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors\nvia a protocol such as LLDP. Two query parameters must be included in the request:\n\n* `peer_device`: The name of the peer device\n* `peer_interface`: The name of the peer interface" }, { "info": { "name": "dcim_console_port_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-port-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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "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": "type", "value": "", "type": "query", "description": "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')]\n* `Other` - [('other', 'Other')]" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query", "description": "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')]\n* `Other` - [('other', 'Other')]" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of console port template objects." }, { "info": { "name": "dcim_console_port_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/console-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of console port template objects." }, { "info": { "name": "dcim_console_port_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of console port template objects." }, { "info": { "name": "dcim_console_port_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of console port template objects." }, { "info": { "name": "dcim_console_port_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of console port template objects." }, { "info": { "name": "dcim_console_port_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-port-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 console port 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 console port template object." }, { "info": { "name": "dcim_console_port_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a console port template object." }, { "info": { "name": "dcim_console_port_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a console port template object." }, { "info": { "name": "dcim_console_port_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console port template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a console port template object." }, { "info": { "name": "dcim_console_ports_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-ports/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "connected", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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": "occupied", "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", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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": "speed", "value": "", "type": "query", "description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps" }, { "name": "speed__ic", "value": "", "type": "query" }, { "name": "speed__ie", "value": "", "type": "query" }, { "name": "speed__iew", "value": "", "type": "query" }, { "name": "speed__iregex", "value": "", "type": "query" }, { "name": "speed__isw", "value": "", "type": "query" }, { "name": "speed__n", "value": "", "type": "query", "description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps" }, { "name": "speed__nic", "value": "", "type": "query" }, { "name": "speed__nie", "value": "", "type": "query" }, { "name": "speed__niew", "value": "", "type": "query" }, { "name": "speed__nisw", "value": "", "type": "query" }, { "name": "speed__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_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "type", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__ie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iregex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__isw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__n", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__niew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nisw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__regex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of console port objects." }, { "info": { "name": "dcim_console_ports_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/console-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of console port objects." }, { "info": { "name": "dcim_console_ports_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of console port objects." }, { "info": { "name": "dcim_console_ports_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of console port objects." }, { "info": { "name": "dcim_console_ports_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of console port objects." }, { "info": { "name": "dcim_console_ports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-ports/: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 console port." }, { "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 console port object." }, { "info": { "name": "dcim_console_ports_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a console port object." }, { "info": { "name": "dcim_console_ports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a console port object." }, { "info": { "name": "dcim_console_ports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console port." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a console port object." }, { "info": { "name": "dcim_console_ports_trace_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-ports/:id/trace/", "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 console port." }, { "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": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." }, { "info": { "name": "dcim_console_server_port_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-server-port-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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "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": "type", "value": "", "type": "query", "description": "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')]\n* `Other` - [('other', 'Other')]" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query", "description": "* `Serial` - [('de-9', 'DE-9'), ('db-25', 'DB-25'), ('rj-11', 'RJ-11'), ('rj-12', 'RJ-12'), ('rj-45', 'RJ-45'), ('mini-din-8', 'Mini-DIN 8')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB')]\n* `Other` - [('other', 'Other')]" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of console server port template objects." }, { "info": { "name": "dcim_console_server_port_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/console-server-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of console server port template objects." }, { "info": { "name": "dcim_console_server_port_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-server-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of console server port template objects." }, { "info": { "name": "dcim_console_server_port_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-server-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of console server port template objects." }, { "info": { "name": "dcim_console_server_port_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-server-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of console server port template objects." }, { "info": { "name": "dcim_console_server_port_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-server-port-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 console server port 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 console server port template object." }, { "info": { "name": "dcim_console_server_port_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-server-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console server port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a console server port template object." }, { "info": { "name": "dcim_console_server_port_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-server-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console server port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a console server port template object." }, { "info": { "name": "dcim_console_server_port_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-server-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console server port template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a console server port template object." }, { "info": { "name": "dcim_console_server_ports_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-server-ports/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "connected", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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": "occupied", "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", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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": "speed", "value": "", "type": "query", "description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps" }, { "name": "speed__ic", "value": "", "type": "query" }, { "name": "speed__ie", "value": "", "type": "query" }, { "name": "speed__iew", "value": "", "type": "query" }, { "name": "speed__iregex", "value": "", "type": "query" }, { "name": "speed__isw", "value": "", "type": "query" }, { "name": "speed__n", "value": "", "type": "query", "description": "Port speed in bits per second\n\n* `1200` - 1200 bps\n* `2400` - 2400 bps\n* `4800` - 4800 bps\n* `9600` - 9600 bps\n* `19200` - 19.2 kbps\n* `38400` - 38.4 kbps\n* `57600` - 57.6 kbps\n* `115200` - 115.2 kbps" }, { "name": "speed__nic", "value": "", "type": "query" }, { "name": "speed__nie", "value": "", "type": "query" }, { "name": "speed__niew", "value": "", "type": "query" }, { "name": "speed__nisw", "value": "", "type": "query" }, { "name": "speed__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_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "type", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__ie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iregex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__isw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__n", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__niew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nisw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__regex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of console server port objects." }, { "info": { "name": "dcim_console_server_ports_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/console-server-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of console server port objects." }, { "info": { "name": "dcim_console_server_ports_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-server-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of console server port objects." }, { "info": { "name": "dcim_console_server_ports_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-server-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of console server port objects." }, { "info": { "name": "dcim_console_server_ports_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-server-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of console server port objects." }, { "info": { "name": "dcim_console_server_ports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-server-ports/: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 console server port." }, { "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 console server port object." }, { "info": { "name": "dcim_console_server_ports_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/console-server-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console server port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a console server port object." }, { "info": { "name": "dcim_console_server_ports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/console-server-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console server port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a console server port object." }, { "info": { "name": "dcim_console_server_ports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/console-server-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this console server port." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a console server port object." }, { "info": { "name": "dcim_console_server_ports_trace_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/console-server-ports/:id/trace/", "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 console server port." }, { "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": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." }, { "info": { "name": "dcim_device_bay_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-bay-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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "enabled", "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "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": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of device bay template objects." }, { "info": { "name": "dcim_device_bay_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/device-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of device bay template objects." }, { "info": { "name": "dcim_device_bay_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of device bay template objects." }, { "info": { "name": "dcim_device_bay_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of device bay template objects." }, { "info": { "name": "dcim_device_bay_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of device bay template objects." }, { "info": { "name": "dcim_device_bay_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-bay-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 device bay 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 device bay template object." }, { "info": { "name": "dcim_device_bay_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-bay-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device bay template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a device bay template object." }, { "info": { "name": "dcim_device_bay_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-bay-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device bay template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a device bay template object." }, { "info": { "name": "dcim_device_bay_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-bay-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device bay template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a device bay template object." }, { "info": { "name": "dcim_device_bays_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-bays/", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "enabled", "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": "installed_device", "value": "", "type": "query", "description": "Installed device (name)" }, { "name": "installed_device__n", "value": "", "type": "query", "description": "Installed device (name)" }, { "name": "installed_device_id", "value": "", "type": "query", "description": "Installed device (ID)" }, { "name": "installed_device_id__n", "value": "", "type": "query", "description": "Installed device (ID)" }, { "name": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "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", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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_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_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of device bay objects." }, { "info": { "name": "dcim_device_bays_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/device-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of device bay objects." }, { "info": { "name": "dcim_device_bays_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of device bay objects." }, { "info": { "name": "dcim_device_bays_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of device bay objects." }, { "info": { "name": "dcim_device_bays_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of device bay objects." }, { "info": { "name": "dcim_device_bays_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-bays/: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 device bay." }, { "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 device bay object." }, { "info": { "name": "dcim_device_bays_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-bays/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device bay." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a device bay object." }, { "info": { "name": "dcim_device_bays_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-bays/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device bay." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a device bay object." }, { "info": { "name": "dcim_device_bays_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-bays/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device bay." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a device bay object." }, { "info": { "name": "dcim_device_roles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-roles/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "value": "", "type": "query" }, { "name": "config_template_id", "value": "", "type": "query", "description": "Config template (ID)" }, { "name": "config_template_id__n", "value": "", "type": "query", "description": "Config template (ID)" }, { "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": "parent", "value": "", "type": "query", "description": "Parent device role (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Parent device role (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Parent device role (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent device role (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": "vm_role", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of device role objects." }, { "info": { "name": "dcim_device_roles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/device-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of device role objects." }, { "info": { "name": "dcim_device_roles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of device role objects." }, { "info": { "name": "dcim_device_roles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of device role objects." }, { "info": { "name": "dcim_device_roles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of device role objects." }, { "info": { "name": "dcim_device_roles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-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 device 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 device role object." }, { "info": { "name": "dcim_device_roles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a device role object." }, { "info": { "name": "dcim_device_roles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a device role object." }, { "info": { "name": "dcim_device_roles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device role." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a device role object." }, { "info": { "name": "dcim_device_types_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-types/", "params": [ { "name": "airflow", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed" }, { "name": "airflow__empty", "value": "", "type": "query" }, { "name": "airflow__ic", "value": "", "type": "query" }, { "name": "airflow__ie", "value": "", "type": "query" }, { "name": "airflow__iew", "value": "", "type": "query" }, { "name": "airflow__iregex", "value": "", "type": "query" }, { "name": "airflow__isw", "value": "", "type": "query" }, { "name": "airflow__n", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed" }, { "name": "airflow__nic", "value": "", "type": "query" }, { "name": "airflow__nie", "value": "", "type": "query" }, { "name": "airflow__niew", "value": "", "type": "query" }, { "name": "airflow__nisw", "value": "", "type": "query" }, { "name": "airflow__regex", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "console_port_template_count", "value": "", "type": "query" }, { "name": "console_port_template_count__empty", "value": "", "type": "query" }, { "name": "console_port_template_count__gt", "value": "", "type": "query" }, { "name": "console_port_template_count__gte", "value": "", "type": "query" }, { "name": "console_port_template_count__lt", "value": "", "type": "query" }, { "name": "console_port_template_count__lte", "value": "", "type": "query" }, { "name": "console_port_template_count__n", "value": "", "type": "query" }, { "name": "console_ports", "value": "", "type": "query", "description": "Has console ports" }, { "name": "console_server_port_template_count", "value": "", "type": "query" }, { "name": "console_server_port_template_count__empty", "value": "", "type": "query" }, { "name": "console_server_port_template_count__gt", "value": "", "type": "query" }, { "name": "console_server_port_template_count__gte", "value": "", "type": "query" }, { "name": "console_server_port_template_count__lt", "value": "", "type": "query" }, { "name": "console_server_port_template_count__lte", "value": "", "type": "query" }, { "name": "console_server_port_template_count__n", "value": "", "type": "query" }, { "name": "console_server_ports", "value": "", "type": "query", "description": "Has console server ports" }, { "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": "default_platform", "value": "", "type": "query" }, { "name": "default_platform__n", "value": "", "type": "query" }, { "name": "default_platform_id", "value": "", "type": "query" }, { "name": "default_platform_id__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": "device_bay_template_count", "value": "", "type": "query" }, { "name": "device_bay_template_count__empty", "value": "", "type": "query" }, { "name": "device_bay_template_count__gt", "value": "", "type": "query" }, { "name": "device_bay_template_count__gte", "value": "", "type": "query" }, { "name": "device_bay_template_count__lt", "value": "", "type": "query" }, { "name": "device_bay_template_count__lte", "value": "", "type": "query" }, { "name": "device_bay_template_count__n", "value": "", "type": "query" }, { "name": "device_bays", "value": "", "type": "query", "description": "Has device bays" }, { "name": "device_count", "value": "", "type": "query" }, { "name": "device_count__empty", "value": "", "type": "query" }, { "name": "device_count__gt", "value": "", "type": "query" }, { "name": "device_count__gte", "value": "", "type": "query" }, { "name": "device_count__lt", "value": "", "type": "query" }, { "name": "device_count__lte", "value": "", "type": "query" }, { "name": "device_count__n", "value": "", "type": "query" }, { "name": "exclude_from_utilization", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "front_port_template_count", "value": "", "type": "query" }, { "name": "front_port_template_count__empty", "value": "", "type": "query" }, { "name": "front_port_template_count__gt", "value": "", "type": "query" }, { "name": "front_port_template_count__gte", "value": "", "type": "query" }, { "name": "front_port_template_count__lt", "value": "", "type": "query" }, { "name": "front_port_template_count__lte", "value": "", "type": "query" }, { "name": "front_port_template_count__n", "value": "", "type": "query" }, { "name": "has_front_image", "value": "", "type": "query", "description": "Has a front image" }, { "name": "has_rear_image", "value": "", "type": "query", "description": "Has a rear image" }, { "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_template_count", "value": "", "type": "query" }, { "name": "interface_template_count__empty", "value": "", "type": "query" }, { "name": "interface_template_count__gt", "value": "", "type": "query" }, { "name": "interface_template_count__gte", "value": "", "type": "query" }, { "name": "interface_template_count__lt", "value": "", "type": "query" }, { "name": "interface_template_count__lte", "value": "", "type": "query" }, { "name": "interface_template_count__n", "value": "", "type": "query" }, { "name": "interfaces", "value": "", "type": "query", "description": "Has interfaces" }, { "name": "inventory_item_template_count", "value": "", "type": "query" }, { "name": "inventory_item_template_count__empty", "value": "", "type": "query" }, { "name": "inventory_item_template_count__gt", "value": "", "type": "query" }, { "name": "inventory_item_template_count__gte", "value": "", "type": "query" }, { "name": "inventory_item_template_count__lt", "value": "", "type": "query" }, { "name": "inventory_item_template_count__lte", "value": "", "type": "query" }, { "name": "inventory_item_template_count__n", "value": "", "type": "query" }, { "name": "inventory_items", "value": "", "type": "query", "description": "Has inventory items" }, { "name": "is_full_depth", "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": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "model", "value": "", "type": "query" }, { "name": "model__empty", "value": "", "type": "query" }, { "name": "model__ic", "value": "", "type": "query" }, { "name": "model__ie", "value": "", "type": "query" }, { "name": "model__iew", "value": "", "type": "query" }, { "name": "model__iregex", "value": "", "type": "query" }, { "name": "model__isw", "value": "", "type": "query" }, { "name": "model__n", "value": "", "type": "query" }, { "name": "model__nic", "value": "", "type": "query" }, { "name": "model__nie", "value": "", "type": "query" }, { "name": "model__niew", "value": "", "type": "query" }, { "name": "model__nisw", "value": "", "type": "query" }, { "name": "model__regex", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_bay_template_count", "value": "", "type": "query" }, { "name": "module_bay_template_count__empty", "value": "", "type": "query" }, { "name": "module_bay_template_count__gt", "value": "", "type": "query" }, { "name": "module_bay_template_count__gte", "value": "", "type": "query" }, { "name": "module_bay_template_count__lt", "value": "", "type": "query" }, { "name": "module_bay_template_count__lte", "value": "", "type": "query" }, { "name": "module_bay_template_count__n", "value": "", "type": "query" }, { "name": "module_bays", "value": "", "type": "query", "description": "Has module bays" }, { "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": "part_number", "value": "", "type": "query" }, { "name": "part_number__empty", "value": "", "type": "query" }, { "name": "part_number__ic", "value": "", "type": "query" }, { "name": "part_number__ie", "value": "", "type": "query" }, { "name": "part_number__iew", "value": "", "type": "query" }, { "name": "part_number__iregex", "value": "", "type": "query" }, { "name": "part_number__isw", "value": "", "type": "query" }, { "name": "part_number__n", "value": "", "type": "query" }, { "name": "part_number__nic", "value": "", "type": "query" }, { "name": "part_number__nie", "value": "", "type": "query" }, { "name": "part_number__niew", "value": "", "type": "query" }, { "name": "part_number__nisw", "value": "", "type": "query" }, { "name": "part_number__regex", "value": "", "type": "query" }, { "name": "pass_through_ports", "value": "", "type": "query", "description": "Has pass-through ports" }, { "name": "power_outlet_template_count", "value": "", "type": "query" }, { "name": "power_outlet_template_count__empty", "value": "", "type": "query" }, { "name": "power_outlet_template_count__gt", "value": "", "type": "query" }, { "name": "power_outlet_template_count__gte", "value": "", "type": "query" }, { "name": "power_outlet_template_count__lt", "value": "", "type": "query" }, { "name": "power_outlet_template_count__lte", "value": "", "type": "query" }, { "name": "power_outlet_template_count__n", "value": "", "type": "query" }, { "name": "power_outlets", "value": "", "type": "query", "description": "Has power outlets" }, { "name": "power_port_template_count", "value": "", "type": "query" }, { "name": "power_port_template_count__empty", "value": "", "type": "query" }, { "name": "power_port_template_count__gt", "value": "", "type": "query" }, { "name": "power_port_template_count__gte", "value": "", "type": "query" }, { "name": "power_port_template_count__lt", "value": "", "type": "query" }, { "name": "power_port_template_count__lte", "value": "", "type": "query" }, { "name": "power_port_template_count__n", "value": "", "type": "query" }, { "name": "power_ports", "value": "", "type": "query", "description": "Has power ports" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rear_port_template_count", "value": "", "type": "query" }, { "name": "rear_port_template_count__empty", "value": "", "type": "query" }, { "name": "rear_port_template_count__gt", "value": "", "type": "query" }, { "name": "rear_port_template_count__gte", "value": "", "type": "query" }, { "name": "rear_port_template_count__lt", "value": "", "type": "query" }, { "name": "rear_port_template_count__lte", "value": "", "type": "query" }, { "name": "rear_port_template_count__n", "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": "subdevice_role", "value": "", "type": "query", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.\n\n* `parent` - Parent\n* `child` - Child" }, { "name": "subdevice_role__empty", "value": "", "type": "query" }, { "name": "subdevice_role__ic", "value": "", "type": "query" }, { "name": "subdevice_role__ie", "value": "", "type": "query" }, { "name": "subdevice_role__iew", "value": "", "type": "query" }, { "name": "subdevice_role__iregex", "value": "", "type": "query" }, { "name": "subdevice_role__isw", "value": "", "type": "query" }, { "name": "subdevice_role__n", "value": "", "type": "query", "description": "Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child.\n\n* `parent` - Parent\n* `child` - Child" }, { "name": "subdevice_role__nic", "value": "", "type": "query" }, { "name": "subdevice_role__nie", "value": "", "type": "query" }, { "name": "subdevice_role__niew", "value": "", "type": "query" }, { "name": "subdevice_role__nisw", "value": "", "type": "query" }, { "name": "subdevice_role__regex", "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": "u_height", "value": "", "type": "query" }, { "name": "u_height__empty", "value": "", "type": "query" }, { "name": "u_height__gt", "value": "", "type": "query" }, { "name": "u_height__gte", "value": "", "type": "query" }, { "name": "u_height__lt", "value": "", "type": "query" }, { "name": "u_height__lte", "value": "", "type": "query" }, { "name": "u_height__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" }, { "name": "weight_unit", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__empty", "value": "", "type": "query" }, { "name": "weight_unit__ic", "value": "", "type": "query" }, { "name": "weight_unit__ie", "value": "", "type": "query" }, { "name": "weight_unit__iew", "value": "", "type": "query" }, { "name": "weight_unit__iregex", "value": "", "type": "query" }, { "name": "weight_unit__isw", "value": "", "type": "query" }, { "name": "weight_unit__n", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__nic", "value": "", "type": "query" }, { "name": "weight_unit__nie", "value": "", "type": "query" }, { "name": "weight_unit__niew", "value": "", "type": "query" }, { "name": "weight_unit__nisw", "value": "", "type": "query" }, { "name": "weight_unit__regex", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of device type objects." }, { "info": { "name": "dcim_device_types_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/device-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of device type objects." }, { "info": { "name": "dcim_device_types_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of device type objects." }, { "info": { "name": "dcim_device_types_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of device type objects." }, { "info": { "name": "dcim_device_types_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of device type objects." }, { "info": { "name": "dcim_device_types_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/device-types/: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 device type." }, { "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 device type object." }, { "info": { "name": "dcim_device_types_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/device-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a device type object." }, { "info": { "name": "dcim_device_types_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/device-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a device type object." }, { "info": { "name": "dcim_device_types_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/device-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device type." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a device type object." }, { "info": { "name": "dcim_devices_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/devices/", "params": [ { "name": "airflow", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed" }, { "name": "airflow__empty", "value": "", "type": "query" }, { "name": "airflow__ic", "value": "", "type": "query" }, { "name": "airflow__ie", "value": "", "type": "query" }, { "name": "airflow__iew", "value": "", "type": "query" }, { "name": "airflow__iregex", "value": "", "type": "query" }, { "name": "airflow__isw", "value": "", "type": "query" }, { "name": "airflow__n", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `rear-to-side` - Rear to side\n* `bottom-to-top` - Bottom to top\n* `top-to-bottom` - Top to bottom\n* `passive` - Passive\n* `mixed` - Mixed" }, { "name": "airflow__nic", "value": "", "type": "query" }, { "name": "airflow__nie", "value": "", "type": "query" }, { "name": "airflow__niew", "value": "", "type": "query" }, { "name": "airflow__nisw", "value": "", "type": "query" }, { "name": "airflow__regex", "value": "", "type": "query" }, { "name": "asset_tag", "value": "", "type": "query" }, { "name": "asset_tag__empty", "value": "", "type": "query" }, { "name": "asset_tag__ic", "value": "", "type": "query" }, { "name": "asset_tag__ie", "value": "", "type": "query" }, { "name": "asset_tag__iew", "value": "", "type": "query" }, { "name": "asset_tag__iregex", "value": "", "type": "query" }, { "name": "asset_tag__isw", "value": "", "type": "query" }, { "name": "asset_tag__n", "value": "", "type": "query" }, { "name": "asset_tag__nic", "value": "", "type": "query" }, { "name": "asset_tag__nie", "value": "", "type": "query" }, { "name": "asset_tag__niew", "value": "", "type": "query" }, { "name": "asset_tag__nisw", "value": "", "type": "query" }, { "name": "asset_tag__regex", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cluster_group", "value": "", "type": "query", "description": "Cluster group (slug)" }, { "name": "cluster_group__n", "value": "", "type": "query", "description": "Cluster group (slug)" }, { "name": "cluster_group_id", "value": "", "type": "query", "description": "Cluster group (ID)" }, { "name": "cluster_group_id__n", "value": "", "type": "query", "description": "Cluster group (ID)" }, { "name": "cluster_id", "value": "", "type": "query", "description": "VM cluster (ID)" }, { "name": "cluster_id__n", "value": "", "type": "query", "description": "VM cluster (ID)" }, { "name": "config_template_id", "value": "", "type": "query", "description": "Config template (ID)" }, { "name": "config_template_id__n", "value": "", "type": "query", "description": "Config template (ID)" }, { "name": "console_port_count", "value": "", "type": "query" }, { "name": "console_port_count__empty", "value": "", "type": "query" }, { "name": "console_port_count__gt", "value": "", "type": "query" }, { "name": "console_port_count__gte", "value": "", "type": "query" }, { "name": "console_port_count__lt", "value": "", "type": "query" }, { "name": "console_port_count__lte", "value": "", "type": "query" }, { "name": "console_port_count__n", "value": "", "type": "query" }, { "name": "console_ports", "value": "", "type": "query", "description": "Has console ports" }, { "name": "console_server_port_count", "value": "", "type": "query" }, { "name": "console_server_port_count__empty", "value": "", "type": "query" }, { "name": "console_server_port_count__gt", "value": "", "type": "query" }, { "name": "console_server_port_count__gte", "value": "", "type": "query" }, { "name": "console_server_port_count__lt", "value": "", "type": "query" }, { "name": "console_server_port_count__lte", "value": "", "type": "query" }, { "name": "console_server_port_count__n", "value": "", "type": "query" }, { "name": "console_server_ports", "value": "", "type": "query", "description": "Has console server ports" }, { "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_bay_count", "value": "", "type": "query" }, { "name": "device_bay_count__empty", "value": "", "type": "query" }, { "name": "device_bay_count__gt", "value": "", "type": "query" }, { "name": "device_bay_count__gte", "value": "", "type": "query" }, { "name": "device_bay_count__lt", "value": "", "type": "query" }, { "name": "device_bay_count__lte", "value": "", "type": "query" }, { "name": "device_bay_count__n", "value": "", "type": "query" }, { "name": "device_bays", "value": "", "type": "query", "description": "Has device bays" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (slug)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (slug)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "face", "value": "", "type": "query", "description": "* `front` - Front\n* `rear` - Rear" }, { "name": "face__empty", "value": "", "type": "query" }, { "name": "face__ic", "value": "", "type": "query" }, { "name": "face__ie", "value": "", "type": "query" }, { "name": "face__iew", "value": "", "type": "query" }, { "name": "face__iregex", "value": "", "type": "query" }, { "name": "face__isw", "value": "", "type": "query" }, { "name": "face__n", "value": "", "type": "query", "description": "* `front` - Front\n* `rear` - Rear" }, { "name": "face__nic", "value": "", "type": "query" }, { "name": "face__nie", "value": "", "type": "query" }, { "name": "face__niew", "value": "", "type": "query" }, { "name": "face__nisw", "value": "", "type": "query" }, { "name": "face__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": "front_port_count", "value": "", "type": "query" }, { "name": "front_port_count__empty", "value": "", "type": "query" }, { "name": "front_port_count__gt", "value": "", "type": "query" }, { "name": "front_port_count__gte", "value": "", "type": "query" }, { "name": "front_port_count__lt", "value": "", "type": "query" }, { "name": "front_port_count__lte", "value": "", "type": "query" }, { "name": "front_port_count__n", "value": "", "type": "query" }, { "name": "has_oob_ip", "value": "", "type": "query", "description": "Has an out-of-band IP" }, { "name": "has_primary_ip", "value": "", "type": "query", "description": "Has a primary IP" }, { "name": "has_virtual_device_context", "value": "", "type": "query", "description": "Has virtual device context" }, { "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_count", "value": "", "type": "query" }, { "name": "interface_count__empty", "value": "", "type": "query" }, { "name": "interface_count__gt", "value": "", "type": "query" }, { "name": "interface_count__gte", "value": "", "type": "query" }, { "name": "interface_count__lt", "value": "", "type": "query" }, { "name": "interface_count__lte", "value": "", "type": "query" }, { "name": "interface_count__n", "value": "", "type": "query" }, { "name": "interfaces", "value": "", "type": "query", "description": "Has interfaces" }, { "name": "inventory_item_count", "value": "", "type": "query" }, { "name": "inventory_item_count__empty", "value": "", "type": "query" }, { "name": "inventory_item_count__gt", "value": "", "type": "query" }, { "name": "inventory_item_count__gte", "value": "", "type": "query" }, { "name": "inventory_item_count__lt", "value": "", "type": "query" }, { "name": "inventory_item_count__lte", "value": "", "type": "query" }, { "name": "inventory_item_count__n", "value": "", "type": "query" }, { "name": "is_full_depth", "value": "", "type": "query", "description": "Is full depth" }, { "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": "latitude", "value": "", "type": "query" }, { "name": "latitude__empty", "value": "", "type": "query" }, { "name": "latitude__gt", "value": "", "type": "query" }, { "name": "latitude__gte", "value": "", "type": "query" }, { "name": "latitude__lt", "value": "", "type": "query" }, { "name": "latitude__lte", "value": "", "type": "query" }, { "name": "latitude__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "local_context_data", "value": "", "type": "query", "description": "Has local config context data" }, { "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": "longitude", "value": "", "type": "query" }, { "name": "longitude__empty", "value": "", "type": "query" }, { "name": "longitude__gt", "value": "", "type": "query" }, { "name": "longitude__gte", "value": "", "type": "query" }, { "name": "longitude__lt", "value": "", "type": "query" }, { "name": "longitude__lte", "value": "", "type": "query" }, { "name": "longitude__n", "value": "", "type": "query" }, { "name": "mac_address", "value": "", "type": "query" }, { "name": "mac_address__ic", "value": "", "type": "query" }, { "name": "mac_address__ie", "value": "", "type": "query" }, { "name": "mac_address__iew", "value": "", "type": "query" }, { "name": "mac_address__iregex", "value": "", "type": "query" }, { "name": "mac_address__isw", "value": "", "type": "query" }, { "name": "mac_address__n", "value": "", "type": "query" }, { "name": "mac_address__nic", "value": "", "type": "query" }, { "name": "mac_address__nie", "value": "", "type": "query" }, { "name": "mac_address__niew", "value": "", "type": "query" }, { "name": "mac_address__nisw", "value": "", "type": "query" }, { "name": "mac_address__regex", "value": "", "type": "query" }, { "name": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "model", "value": "", "type": "query", "description": "Device model (slug)" }, { "name": "model__n", "value": "", "type": "query", "description": "Device model (slug)" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_bay_count", "value": "", "type": "query" }, { "name": "module_bay_count__empty", "value": "", "type": "query" }, { "name": "module_bay_count__gt", "value": "", "type": "query" }, { "name": "module_bay_count__gte", "value": "", "type": "query" }, { "name": "module_bay_count__lt", "value": "", "type": "query" }, { "name": "module_bay_count__lte", "value": "", "type": "query" }, { "name": "module_bay_count__n", "value": "", "type": "query" }, { "name": "module_bays", "value": "", "type": "query", "description": "Has module bays" }, { "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": "oob_ip_id", "value": "", "type": "query", "description": "OOB IP (ID)" }, { "name": "oob_ip_id__n", "value": "", "type": "query", "description": "OOB IP (ID)" }, { "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_bay_id", "value": "", "type": "query", "description": "Parent bay (ID)" }, { "name": "parent_bay_id__n", "value": "", "type": "query", "description": "Parent bay (ID)" }, { "name": "parent_device_id", "value": "", "type": "query", "description": "Parent Device (ID)" }, { "name": "parent_device_id__n", "value": "", "type": "query", "description": "Parent Device (ID)" }, { "name": "pass_through_ports", "value": "", "type": "query", "description": "Has pass-through ports" }, { "name": "platform", "value": "", "type": "query" }, { "name": "platform__n", "value": "", "type": "query" }, { "name": "platform_id", "value": "", "type": "query" }, { "name": "platform_id__n", "value": "", "type": "query" }, { "name": "position", "value": "", "type": "query" }, { "name": "position__empty", "value": "", "type": "query" }, { "name": "position__gt", "value": "", "type": "query" }, { "name": "position__gte", "value": "", "type": "query" }, { "name": "position__lt", "value": "", "type": "query" }, { "name": "position__lte", "value": "", "type": "query" }, { "name": "position__n", "value": "", "type": "query" }, { "name": "power_outlet_count", "value": "", "type": "query" }, { "name": "power_outlet_count__empty", "value": "", "type": "query" }, { "name": "power_outlet_count__gt", "value": "", "type": "query" }, { "name": "power_outlet_count__gte", "value": "", "type": "query" }, { "name": "power_outlet_count__lt", "value": "", "type": "query" }, { "name": "power_outlet_count__lte", "value": "", "type": "query" }, { "name": "power_outlet_count__n", "value": "", "type": "query" }, { "name": "power_outlets", "value": "", "type": "query", "description": "Has power outlets" }, { "name": "power_port_count", "value": "", "type": "query" }, { "name": "power_port_count__empty", "value": "", "type": "query" }, { "name": "power_port_count__gt", "value": "", "type": "query" }, { "name": "power_port_count__gte", "value": "", "type": "query" }, { "name": "power_port_count__lt", "value": "", "type": "query" }, { "name": "power_port_count__lte", "value": "", "type": "query" }, { "name": "power_port_count__n", "value": "", "type": "query" }, { "name": "power_ports", "value": "", "type": "query", "description": "Has power ports" }, { "name": "primary_ip4", "value": "", "type": "query", "description": "Primary IPv4 (address)" }, { "name": "primary_ip4__n", "value": "", "type": "query", "description": "Primary IPv4 (address)" }, { "name": "primary_ip4_id", "value": "", "type": "query", "description": "Primary IPv4 (ID)" }, { "name": "primary_ip4_id__n", "value": "", "type": "query", "description": "Primary IPv4 (ID)" }, { "name": "primary_ip6", "value": "", "type": "query", "description": "Primary IPv6 (address)" }, { "name": "primary_ip6__n", "value": "", "type": "query", "description": "Primary IPv6 (address)" }, { "name": "primary_ip6_id", "value": "", "type": "query", "description": "Primary IPv6 (ID)" }, { "name": "primary_ip6_id__n", "value": "", "type": "query", "description": "Primary IPv6 (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rear_port_count", "value": "", "type": "query" }, { "name": "rear_port_count__empty", "value": "", "type": "query" }, { "name": "rear_port_count__gt", "value": "", "type": "query" }, { "name": "rear_port_count__gte", "value": "", "type": "query" }, { "name": "rear_port_count__lt", "value": "", "type": "query" }, { "name": "rear_port_count__lte", "value": "", "type": "query" }, { "name": "rear_port_count__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" }, { "name": "role__n", "value": "", "type": "query" }, { "name": "role_id", "value": "", "type": "query" }, { "name": "role_id__n", "value": "", "type": "query" }, { "name": "serial", "value": "", "type": "query" }, { "name": "serial__empty", "value": "", "type": "query" }, { "name": "serial__ic", "value": "", "type": "query" }, { "name": "serial__ie", "value": "", "type": "query" }, { "name": "serial__iew", "value": "", "type": "query" }, { "name": "serial__iregex", "value": "", "type": "query" }, { "name": "serial__isw", "value": "", "type": "query" }, { "name": "serial__n", "value": "", "type": "query" }, { "name": "serial__nic", "value": "", "type": "query" }, { "name": "serial__nie", "value": "", "type": "query" }, { "name": "serial__niew", "value": "", "type": "query" }, { "name": "serial__nisw", "value": "", "type": "query" }, { "name": "serial__regex", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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" }, { "name": "vc_position", "value": "", "type": "query" }, { "name": "vc_position__empty", "value": "", "type": "query" }, { "name": "vc_position__gt", "value": "", "type": "query" }, { "name": "vc_position__gte", "value": "", "type": "query" }, { "name": "vc_position__lt", "value": "", "type": "query" }, { "name": "vc_position__lte", "value": "", "type": "query" }, { "name": "vc_position__n", "value": "", "type": "query" }, { "name": "vc_priority", "value": "", "type": "query" }, { "name": "vc_priority__empty", "value": "", "type": "query" }, { "name": "vc_priority__gt", "value": "", "type": "query" }, { "name": "vc_priority__gte", "value": "", "type": "query" }, { "name": "vc_priority__lt", "value": "", "type": "query" }, { "name": "vc_priority__lte", "value": "", "type": "query" }, { "name": "vc_priority__n", "value": "", "type": "query" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual chassis (ID)" }, { "name": "virtual_chassis_member", "value": "", "type": "query", "description": "Is a virtual chassis member" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of device objects." }, { "info": { "name": "dcim_devices_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/devices/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of device objects." }, { "info": { "name": "dcim_devices_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/devices/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of device objects." }, { "info": { "name": "dcim_devices_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/devices/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of device objects." }, { "info": { "name": "dcim_devices_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/devices/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of device objects." }, { "info": { "name": "dcim_devices_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/devices/: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 device." }, { "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 device object." }, { "info": { "name": "dcim_devices_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/devices/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a device object." }, { "info": { "name": "dcim_devices_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/devices/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a device object." }, { "info": { "name": "dcim_devices_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/devices/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a device object." }, { "info": { "name": "dcim_devices_render_config_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/devices/:id/render-config/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this device." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Resolve and render the preferred ConfigTemplate for this Device or Virtual Machine." }, { "info": { "name": "dcim_front_port_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/front-port-templates/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "positions", "value": "", "type": "query" }, { "name": "positions__empty", "value": "", "type": "query" }, { "name": "positions__gt", "value": "", "type": "query" }, { "name": "positions__gte", "value": "", "type": "query" }, { "name": "positions__lt", "value": "", "type": "query" }, { "name": "positions__lte", "value": "", "type": "query" }, { "name": "positions__n", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rear_port_id", "value": "", "type": "query", "description": "Rear port (ID)" }, { "name": "rear_port_id__n", "value": "", "type": "query", "description": "Rear port (ID)" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of front port template objects." }, { "info": { "name": "dcim_front_port_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/front-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of front port template objects." }, { "info": { "name": "dcim_front_port_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/front-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of front port template objects." }, { "info": { "name": "dcim_front_port_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/front-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of front port template objects." }, { "info": { "name": "dcim_front_port_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/front-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of front port template objects." }, { "info": { "name": "dcim_front_port_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/front-port-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 front port 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 front port template object." }, { "info": { "name": "dcim_front_port_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/front-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this front port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a front port template object." }, { "info": { "name": "dcim_front_port_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/front-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this front port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a front port template object." }, { "info": { "name": "dcim_front_port_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/front-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this front port template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a front port template object." }, { "info": { "name": "dcim_front_ports_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/front-ports/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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": "occupied", "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": "positions", "value": "", "type": "query" }, { "name": "positions__empty", "value": "", "type": "query" }, { "name": "positions__gt", "value": "", "type": "query" }, { "name": "positions__gte", "value": "", "type": "query" }, { "name": "positions__lt", "value": "", "type": "query" }, { "name": "positions__lte", "value": "", "type": "query" }, { "name": "positions__n", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rear_port_id", "value": "", "type": "query", "description": "Rear port (ID)" }, { "name": "rear_port_id__n", "value": "", "type": "query", "description": "Rear port (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of front port objects." }, { "info": { "name": "dcim_front_ports_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/front-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of front port objects." }, { "info": { "name": "dcim_front_ports_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/front-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of front port objects." }, { "info": { "name": "dcim_front_ports_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/front-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of front port objects." }, { "info": { "name": "dcim_front_ports_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/front-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of front port objects." }, { "info": { "name": "dcim_front_ports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/front-ports/: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 front port." }, { "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 front port object." }, { "info": { "name": "dcim_front_ports_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/front-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this front port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a front port object." }, { "info": { "name": "dcim_front_ports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/front-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this front port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a front port object." }, { "info": { "name": "dcim_front_ports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/front-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this front port." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a front port object." }, { "info": { "name": "dcim_front_ports_paths_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/front-ports/:id/paths/", "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 front port." }, { "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": "Return all CablePaths which traverse a given pass-through port." }, { "info": { "name": "dcim_interface_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/interface-templates/", "params": [ { "name": "bridge_id", "value": "", "type": "query" }, { "name": "bridge_id__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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "enabled", "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "mgmt_only", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "poe_mode", "value": "", "type": "query" }, { "name": "poe_mode__empty", "value": "", "type": "query" }, { "name": "poe_mode__ic", "value": "", "type": "query" }, { "name": "poe_mode__ie", "value": "", "type": "query" }, { "name": "poe_mode__iew", "value": "", "type": "query" }, { "name": "poe_mode__iregex", "value": "", "type": "query" }, { "name": "poe_mode__isw", "value": "", "type": "query" }, { "name": "poe_mode__n", "value": "", "type": "query" }, { "name": "poe_mode__nic", "value": "", "type": "query" }, { "name": "poe_mode__nie", "value": "", "type": "query" }, { "name": "poe_mode__niew", "value": "", "type": "query" }, { "name": "poe_mode__nisw", "value": "", "type": "query" }, { "name": "poe_mode__regex", "value": "", "type": "query" }, { "name": "poe_type", "value": "", "type": "query" }, { "name": "poe_type__empty", "value": "", "type": "query" }, { "name": "poe_type__ic", "value": "", "type": "query" }, { "name": "poe_type__ie", "value": "", "type": "query" }, { "name": "poe_type__iew", "value": "", "type": "query" }, { "name": "poe_type__iregex", "value": "", "type": "query" }, { "name": "poe_type__isw", "value": "", "type": "query" }, { "name": "poe_type__n", "value": "", "type": "query" }, { "name": "poe_type__nic", "value": "", "type": "query" }, { "name": "poe_type__nie", "value": "", "type": "query" }, { "name": "poe_type__niew", "value": "", "type": "query" }, { "name": "poe_type__nisw", "value": "", "type": "query" }, { "name": "poe_type__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rf_role", "value": "", "type": "query" }, { "name": "rf_role__empty", "value": "", "type": "query" }, { "name": "rf_role__ic", "value": "", "type": "query" }, { "name": "rf_role__ie", "value": "", "type": "query" }, { "name": "rf_role__iew", "value": "", "type": "query" }, { "name": "rf_role__iregex", "value": "", "type": "query" }, { "name": "rf_role__isw", "value": "", "type": "query" }, { "name": "rf_role__n", "value": "", "type": "query" }, { "name": "rf_role__nic", "value": "", "type": "query" }, { "name": "rf_role__nie", "value": "", "type": "query" }, { "name": "rf_role__niew", "value": "", "type": "query" }, { "name": "rf_role__nisw", "value": "", "type": "query" }, { "name": "rf_role__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": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of interface template objects." }, { "info": { "name": "dcim_interface_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/interface-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of interface template objects." }, { "info": { "name": "dcim_interface_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/interface-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of interface template objects." }, { "info": { "name": "dcim_interface_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/interface-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of interface template objects." }, { "info": { "name": "dcim_interface_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/interface-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of interface template objects." }, { "info": { "name": "dcim_interface_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/interface-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 interface 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 interface template object." }, { "info": { "name": "dcim_interface_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/interface-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this interface template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a interface template object." }, { "info": { "name": "dcim_interface_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/interface-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this interface template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a interface template object." }, { "info": { "name": "dcim_interface_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/interface-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this interface template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a interface template object." }, { "info": { "name": "dcim_interfaces_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/interfaces/", "params": [ { "name": "bridge_id", "value": "", "type": "query", "description": "Bridged interface (ID)" }, { "name": "bridge_id__n", "value": "", "type": "query", "description": "Bridged interface (ID)" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "connected", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "duplex", "value": "", "type": "query" }, { "name": "duplex__empty", "value": "", "type": "query" }, { "name": "duplex__ic", "value": "", "type": "query" }, { "name": "duplex__ie", "value": "", "type": "query" }, { "name": "duplex__iew", "value": "", "type": "query" }, { "name": "duplex__iregex", "value": "", "type": "query" }, { "name": "duplex__isw", "value": "", "type": "query" }, { "name": "duplex__n", "value": "", "type": "query" }, { "name": "duplex__nic", "value": "", "type": "query" }, { "name": "duplex__nie", "value": "", "type": "query" }, { "name": "duplex__niew", "value": "", "type": "query" }, { "name": "duplex__nisw", "value": "", "type": "query" }, { "name": "duplex__regex", "value": "", "type": "query" }, { "name": "enabled", "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": "kind", "value": "", "type": "query", "description": "Kind of interface" }, { "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "value": "", "type": "query" }, { "name": "lag_id", "value": "", "type": "query", "description": "LAG interface (ID)" }, { "name": "lag_id__n", "value": "", "type": "query", "description": "LAG 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": "location", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mac_address", "value": "", "type": "query" }, { "name": "mac_address__ic", "value": "", "type": "query" }, { "name": "mac_address__ie", "value": "", "type": "query" }, { "name": "mac_address__iew", "value": "", "type": "query" }, { "name": "mac_address__iregex", "value": "", "type": "query" }, { "name": "mac_address__isw", "value": "", "type": "query" }, { "name": "mac_address__n", "value": "", "type": "query" }, { "name": "mac_address__nic", "value": "", "type": "query" }, { "name": "mac_address__nie", "value": "", "type": "query" }, { "name": "mac_address__niew", "value": "", "type": "query" }, { "name": "mac_address__nisw", "value": "", "type": "query" }, { "name": "mac_address__regex", "value": "", "type": "query" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "mgmt_only", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__empty", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__ic", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__ie", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__iew", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__iregex", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__isw", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__n", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__nic", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__nie", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__niew", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__nisw", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "mode__regex", "value": "", "type": "query", "description": "802.1Q Mode" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "mtu", "value": "", "type": "query" }, { "name": "mtu__empty", "value": "", "type": "query" }, { "name": "mtu__gt", "value": "", "type": "query" }, { "name": "mtu__gte", "value": "", "type": "query" }, { "name": "mtu__lt", "value": "", "type": "query" }, { "name": "mtu__lte", "value": "", "type": "query" }, { "name": "mtu__n", "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": "occupied", "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_id", "value": "", "type": "query", "description": "Parent interface (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent interface (ID)" }, { "name": "poe_mode", "value": "", "type": "query" }, { "name": "poe_mode__empty", "value": "", "type": "query" }, { "name": "poe_mode__ic", "value": "", "type": "query" }, { "name": "poe_mode__ie", "value": "", "type": "query" }, { "name": "poe_mode__iew", "value": "", "type": "query" }, { "name": "poe_mode__iregex", "value": "", "type": "query" }, { "name": "poe_mode__isw", "value": "", "type": "query" }, { "name": "poe_mode__n", "value": "", "type": "query" }, { "name": "poe_mode__nic", "value": "", "type": "query" }, { "name": "poe_mode__nie", "value": "", "type": "query" }, { "name": "poe_mode__niew", "value": "", "type": "query" }, { "name": "poe_mode__nisw", "value": "", "type": "query" }, { "name": "poe_mode__regex", "value": "", "type": "query" }, { "name": "poe_type", "value": "", "type": "query" }, { "name": "poe_type__empty", "value": "", "type": "query" }, { "name": "poe_type__ic", "value": "", "type": "query" }, { "name": "poe_type__ie", "value": "", "type": "query" }, { "name": "poe_type__iew", "value": "", "type": "query" }, { "name": "poe_type__iregex", "value": "", "type": "query" }, { "name": "poe_type__isw", "value": "", "type": "query" }, { "name": "poe_type__n", "value": "", "type": "query" }, { "name": "poe_type__nic", "value": "", "type": "query" }, { "name": "poe_type__nie", "value": "", "type": "query" }, { "name": "poe_type__niew", "value": "", "type": "query" }, { "name": "poe_type__nisw", "value": "", "type": "query" }, { "name": "poe_type__regex", "value": "", "type": "query" }, { "name": "primary_mac_address", "value": "", "type": "query", "description": "Primary MAC address" }, { "name": "primary_mac_address__n", "value": "", "type": "query", "description": "Primary MAC address" }, { "name": "primary_mac_address_id", "value": "", "type": "query", "description": "Primary MAC address (ID)" }, { "name": "primary_mac_address_id__n", "value": "", "type": "query", "description": "Primary MAC address (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "rf_channel", "value": "", "type": "query" }, { "name": "rf_channel__empty", "value": "", "type": "query" }, { "name": "rf_channel__ic", "value": "", "type": "query" }, { "name": "rf_channel__ie", "value": "", "type": "query" }, { "name": "rf_channel__iew", "value": "", "type": "query" }, { "name": "rf_channel__iregex", "value": "", "type": "query" }, { "name": "rf_channel__isw", "value": "", "type": "query" }, { "name": "rf_channel__n", "value": "", "type": "query" }, { "name": "rf_channel__nic", "value": "", "type": "query" }, { "name": "rf_channel__nie", "value": "", "type": "query" }, { "name": "rf_channel__niew", "value": "", "type": "query" }, { "name": "rf_channel__nisw", "value": "", "type": "query" }, { "name": "rf_channel__regex", "value": "", "type": "query" }, { "name": "rf_channel_frequency", "value": "", "type": "query" }, { "name": "rf_channel_frequency__empty", "value": "", "type": "query" }, { "name": "rf_channel_frequency__gt", "value": "", "type": "query" }, { "name": "rf_channel_frequency__gte", "value": "", "type": "query" }, { "name": "rf_channel_frequency__lt", "value": "", "type": "query" }, { "name": "rf_channel_frequency__lte", "value": "", "type": "query" }, { "name": "rf_channel_frequency__n", "value": "", "type": "query" }, { "name": "rf_channel_width", "value": "", "type": "query" }, { "name": "rf_channel_width__empty", "value": "", "type": "query" }, { "name": "rf_channel_width__gt", "value": "", "type": "query" }, { "name": "rf_channel_width__gte", "value": "", "type": "query" }, { "name": "rf_channel_width__lt", "value": "", "type": "query" }, { "name": "rf_channel_width__lte", "value": "", "type": "query" }, { "name": "rf_channel_width__n", "value": "", "type": "query" }, { "name": "rf_role", "value": "", "type": "query" }, { "name": "rf_role__empty", "value": "", "type": "query" }, { "name": "rf_role__ic", "value": "", "type": "query" }, { "name": "rf_role__ie", "value": "", "type": "query" }, { "name": "rf_role__iew", "value": "", "type": "query" }, { "name": "rf_role__iregex", "value": "", "type": "query" }, { "name": "rf_role__isw", "value": "", "type": "query" }, { "name": "rf_role__n", "value": "", "type": "query" }, { "name": "rf_role__nic", "value": "", "type": "query" }, { "name": "rf_role__nie", "value": "", "type": "query" }, { "name": "rf_role__niew", "value": "", "type": "query" }, { "name": "rf_role__nisw", "value": "", "type": "query" }, { "name": "rf_role__regex", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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": "speed", "value": "", "type": "query" }, { "name": "speed__empty", "value": "", "type": "query" }, { "name": "speed__gt", "value": "", "type": "query" }, { "name": "speed__gte", "value": "", "type": "query" }, { "name": "speed__lt", "value": "", "type": "query" }, { "name": "speed__lte", "value": "", "type": "query" }, { "name": "speed__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": "tenant", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant__n", "value": "", "type": "query", "description": "Tenant (slug)" }, { "name": "tenant_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tx_power", "value": "", "type": "query" }, { "name": "tx_power__empty", "value": "", "type": "query" }, { "name": "tx_power__gt", "value": "", "type": "query" }, { "name": "tx_power__gte", "value": "", "type": "query" }, { "name": "tx_power__lt", "value": "", "type": "query" }, { "name": "tx_power__lte", "value": "", "type": "query" }, { "name": "tx_power__n", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "vdc", "value": "", "type": "query", "description": "Virtual Device Context" }, { "name": "vdc__n", "value": "", "type": "query", "description": "Virtual Device Context" }, { "name": "vdc_id", "value": "", "type": "query", "description": "Virtual Device Context" }, { "name": "vdc_id__n", "value": "", "type": "query", "description": "Virtual Device Context" }, { "name": "vdc_identifier", "value": "", "type": "query", "description": "Virtual Device Context (Identifier)" }, { "name": "vdc_identifier__n", "value": "", "type": "query", "description": "Virtual Device Context (Identifier)" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_member", "value": "", "type": "query" }, { "name": "virtual_chassis_member_id", "value": "", "type": "query" }, { "name": "virtual_chassis_member_or_master", "value": "", "type": "query" }, { "name": "virtual_chassis_member_or_master_id", "value": "", "type": "query" }, { "name": "virtual_circuit_id", "value": "", "type": "query", "description": "Virtual circuit (ID)" }, { "name": "virtual_circuit_id__n", "value": "", "type": "query", "description": "Virtual circuit (ID)" }, { "name": "virtual_circuit_termination_id", "value": "", "type": "query", "description": "Virtual circuit termination (ID)" }, { "name": "virtual_circuit_termination_id__n", "value": "", "type": "query", "description": "Virtual circuit termination (ID)" }, { "name": "vlan", "value": "", "type": "query", "description": "Assigned VID" }, { "name": "vlan_id", "value": "", "type": "query", "description": "Assigned VLAN" }, { "name": "vlan_translation_policy", "value": "", "type": "query", "description": "VLAN Translation Policy" }, { "name": "vlan_translation_policy__n", "value": "", "type": "query", "description": "VLAN Translation Policy" }, { "name": "vlan_translation_policy_id", "value": "", "type": "query", "description": "VLAN Translation Policy (ID)" }, { "name": "vlan_translation_policy_id__n", "value": "", "type": "query", "description": "VLAN Translation Policy (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" }, { "name": "wireless_lan_id", "value": "", "type": "query", "description": "Wireless LAN" }, { "name": "wireless_lan_id__n", "value": "", "type": "query", "description": "Wireless LAN" }, { "name": "wireless_link_id", "value": "", "type": "query", "description": "Wireless link" }, { "name": "wireless_link_id__n", "value": "", "type": "query", "description": "Wireless link" }, { "name": "wwn", "value": "", "type": "query" }, { "name": "wwn__ic", "value": "", "type": "query" }, { "name": "wwn__ie", "value": "", "type": "query" }, { "name": "wwn__iew", "value": "", "type": "query" }, { "name": "wwn__iregex", "value": "", "type": "query" }, { "name": "wwn__isw", "value": "", "type": "query" }, { "name": "wwn__n", "value": "", "type": "query" }, { "name": "wwn__nic", "value": "", "type": "query" }, { "name": "wwn__nie", "value": "", "type": "query" }, { "name": "wwn__niew", "value": "", "type": "query" }, { "name": "wwn__nisw", "value": "", "type": "query" }, { "name": "wwn__regex", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of interface objects." }, { "info": { "name": "dcim_interfaces_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/interfaces/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of interface objects." }, { "info": { "name": "dcim_interfaces_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/interfaces/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of interface objects." }, { "info": { "name": "dcim_interfaces_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/interfaces/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of interface objects." }, { "info": { "name": "dcim_interfaces_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/interfaces/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of interface objects." }, { "info": { "name": "dcim_interfaces_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/interfaces/: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 interface." }, { "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 interface object." }, { "info": { "name": "dcim_interfaces_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/interfaces/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this interface." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a interface object." }, { "info": { "name": "dcim_interfaces_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/interfaces/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this interface." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a interface object." }, { "info": { "name": "dcim_interfaces_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/interfaces/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this interface." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a interface object." }, { "info": { "name": "dcim_interfaces_trace_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/interfaces/:id/trace/", "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 interface." }, { "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": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." }, { "info": { "name": "dcim_inventory_item_roles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/inventory-item-roles/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "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 inventory item role objects." }, { "info": { "name": "dcim_inventory_item_roles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/inventory-item-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of inventory item role objects." }, { "info": { "name": "dcim_inventory_item_roles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/inventory-item-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of inventory item role objects." }, { "info": { "name": "dcim_inventory_item_roles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/inventory-item-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of inventory item role objects." }, { "info": { "name": "dcim_inventory_item_roles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/inventory-item-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of inventory item role objects." }, { "info": { "name": "dcim_inventory_item_roles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/inventory-item-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 inventory item 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 inventory item role object." }, { "info": { "name": "dcim_inventory_item_roles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/inventory-item-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a inventory item role object." }, { "info": { "name": "dcim_inventory_item_roles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/inventory-item-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a inventory item role object." }, { "info": { "name": "dcim_inventory_item_roles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/inventory-item-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item role." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a inventory item role object." }, { "info": { "name": "dcim_inventory_item_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/inventory-item-templates/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "component_id", "value": "", "type": "query" }, { "name": "component_id__empty", "value": "", "type": "query" }, { "name": "component_id__gt", "value": "", "type": "query" }, { "name": "component_id__gte", "value": "", "type": "query" }, { "name": "component_id__lt", "value": "", "type": "query" }, { "name": "component_id__lte", "value": "", "type": "query" }, { "name": "component_id__n", "value": "", "type": "query" }, { "name": "component_type", "value": "", "type": "query" }, { "name": "component_type__n", "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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "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": "parent_id", "value": "", "type": "query", "description": "Parent inventory item (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent inventory item (ID)" }, { "name": "part_id", "value": "", "type": "query" }, { "name": "part_id__empty", "value": "", "type": "query" }, { "name": "part_id__ic", "value": "", "type": "query" }, { "name": "part_id__ie", "value": "", "type": "query" }, { "name": "part_id__iew", "value": "", "type": "query" }, { "name": "part_id__iregex", "value": "", "type": "query" }, { "name": "part_id__isw", "value": "", "type": "query" }, { "name": "part_id__n", "value": "", "type": "query" }, { "name": "part_id__nic", "value": "", "type": "query" }, { "name": "part_id__nie", "value": "", "type": "query" }, { "name": "part_id__niew", "value": "", "type": "query" }, { "name": "part_id__nisw", "value": "", "type": "query" }, { "name": "part_id__regex", "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": "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" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of inventory item template objects." }, { "info": { "name": "dcim_inventory_item_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/inventory-item-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of inventory item template objects." }, { "info": { "name": "dcim_inventory_item_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/inventory-item-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of inventory item template objects." }, { "info": { "name": "dcim_inventory_item_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/inventory-item-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of inventory item template objects." }, { "info": { "name": "dcim_inventory_item_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/inventory-item-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of inventory item template objects." }, { "info": { "name": "dcim_inventory_item_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/inventory-item-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 inventory item 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 inventory item template object." }, { "info": { "name": "dcim_inventory_item_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/inventory-item-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a inventory item template object." }, { "info": { "name": "dcim_inventory_item_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/inventory-item-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a inventory item template object." }, { "info": { "name": "dcim_inventory_item_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/inventory-item-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a inventory item template object." }, { "info": { "name": "dcim_inventory_items_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/inventory-items/", "params": [ { "name": "asset_tag", "value": "", "type": "query" }, { "name": "asset_tag__empty", "value": "", "type": "query" }, { "name": "asset_tag__ic", "value": "", "type": "query" }, { "name": "asset_tag__ie", "value": "", "type": "query" }, { "name": "asset_tag__iew", "value": "", "type": "query" }, { "name": "asset_tag__iregex", "value": "", "type": "query" }, { "name": "asset_tag__isw", "value": "", "type": "query" }, { "name": "asset_tag__n", "value": "", "type": "query" }, { "name": "asset_tag__nic", "value": "", "type": "query" }, { "name": "asset_tag__nie", "value": "", "type": "query" }, { "name": "asset_tag__niew", "value": "", "type": "query" }, { "name": "asset_tag__nisw", "value": "", "type": "query" }, { "name": "asset_tag__regex", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "component_id", "value": "", "type": "query" }, { "name": "component_id__empty", "value": "", "type": "query" }, { "name": "component_id__gt", "value": "", "type": "query" }, { "name": "component_id__gte", "value": "", "type": "query" }, { "name": "component_id__lt", "value": "", "type": "query" }, { "name": "component_id__lte", "value": "", "type": "query" }, { "name": "component_id__n", "value": "", "type": "query" }, { "name": "component_type", "value": "", "type": "query" }, { "name": "component_type__n", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "discovered", "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "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_id", "value": "", "type": "query", "description": "Parent inventory item (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent inventory item (ID)" }, { "name": "part_id", "value": "", "type": "query" }, { "name": "part_id__empty", "value": "", "type": "query" }, { "name": "part_id__ic", "value": "", "type": "query" }, { "name": "part_id__ie", "value": "", "type": "query" }, { "name": "part_id__iew", "value": "", "type": "query" }, { "name": "part_id__iregex", "value": "", "type": "query" }, { "name": "part_id__isw", "value": "", "type": "query" }, { "name": "part_id__n", "value": "", "type": "query" }, { "name": "part_id__nic", "value": "", "type": "query" }, { "name": "part_id__nie", "value": "", "type": "query" }, { "name": "part_id__niew", "value": "", "type": "query" }, { "name": "part_id__nisw", "value": "", "type": "query" }, { "name": "part_id__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "serial", "value": "", "type": "query" }, { "name": "serial__empty", "value": "", "type": "query" }, { "name": "serial__ic", "value": "", "type": "query" }, { "name": "serial__ie", "value": "", "type": "query" }, { "name": "serial__iew", "value": "", "type": "query" }, { "name": "serial__iregex", "value": "", "type": "query" }, { "name": "serial__isw", "value": "", "type": "query" }, { "name": "serial__n", "value": "", "type": "query" }, { "name": "serial__nic", "value": "", "type": "query" }, { "name": "serial__nie", "value": "", "type": "query" }, { "name": "serial__niew", "value": "", "type": "query" }, { "name": "serial__nisw", "value": "", "type": "query" }, { "name": "serial__regex", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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_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_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of inventory item objects." }, { "info": { "name": "dcim_inventory_items_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/inventory-items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of inventory item objects." }, { "info": { "name": "dcim_inventory_items_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/inventory-items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of inventory item objects." }, { "info": { "name": "dcim_inventory_items_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/inventory-items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of inventory item objects." }, { "info": { "name": "dcim_inventory_items_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/inventory-items/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of inventory item objects." }, { "info": { "name": "dcim_inventory_items_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/inventory-items/: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 inventory item." }, { "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 inventory item object." }, { "info": { "name": "dcim_inventory_items_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/inventory-items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a inventory item object." }, { "info": { "name": "dcim_inventory_items_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/inventory-items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a inventory item object." }, { "info": { "name": "dcim_inventory_items_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/inventory-items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this inventory item." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a inventory item object." }, { "info": { "name": "dcim_locations_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/locations/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "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": "facility", "value": "", "type": "query" }, { "name": "facility__empty", "value": "", "type": "query" }, { "name": "facility__ic", "value": "", "type": "query" }, { "name": "facility__ie", "value": "", "type": "query" }, { "name": "facility__iew", "value": "", "type": "query" }, { "name": "facility__iregex", "value": "", "type": "query" }, { "name": "facility__isw", "value": "", "type": "query" }, { "name": "facility__n", "value": "", "type": "query" }, { "name": "facility__nic", "value": "", "type": "query" }, { "name": "facility__nie", "value": "", "type": "query" }, { "name": "facility__niew", "value": "", "type": "query" }, { "name": "facility__nisw", "value": "", "type": "query" }, { "name": "facility__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": "parent", "value": "", "type": "query", "description": "Parent location (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Parent location (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Parent location (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent location (ID)" }, { "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": "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": "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": "status", "value": "", "type": "query" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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 location objects." }, { "info": { "name": "dcim_locations_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/locations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of location objects." }, { "info": { "name": "dcim_locations_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/locations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of location objects." }, { "info": { "name": "dcim_locations_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/locations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of location objects." }, { "info": { "name": "dcim_locations_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/locations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of location objects." }, { "info": { "name": "dcim_locations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/locations/: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 location." }, { "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 location object." }, { "info": { "name": "dcim_locations_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/locations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a location object." }, { "info": { "name": "dcim_locations_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/locations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this location." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a location object." }, { "info": { "name": "dcim_locations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/locations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this location." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a location object." }, { "info": { "name": "dcim_mac_addresses_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/mac-addresses/", "params": [ { "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": "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": "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": "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": "mac_address", "value": "", "type": "query" }, { "name": "mac_address__ic", "value": "", "type": "query" }, { "name": "mac_address__ie", "value": "", "type": "query" }, { "name": "mac_address__iew", "value": "", "type": "query" }, { "name": "mac_address__iregex", "value": "", "type": "query" }, { "name": "mac_address__isw", "value": "", "type": "query" }, { "name": "mac_address__n", "value": "", "type": "query" }, { "name": "mac_address__nic", "value": "", "type": "query" }, { "name": "mac_address__nie", "value": "", "type": "query" }, { "name": "mac_address__niew", "value": "", "type": "query" }, { "name": "mac_address__nisw", "value": "", "type": "query" }, { "name": "mac_address__regex", "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": "primary", "value": "", "type": "query", "description": "Is primary" }, { "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" }, { "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)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of MAC address objects." }, { "info": { "name": "dcim_mac_addresses_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/mac-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of MAC address objects." }, { "info": { "name": "dcim_mac_addresses_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/mac-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of MAC address objects." }, { "info": { "name": "dcim_mac_addresses_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/mac-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of MAC address objects." }, { "info": { "name": "dcim_mac_addresses_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/mac-addresses/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of MAC address objects." }, { "info": { "name": "dcim_mac_addresses_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/mac-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 MAC 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 MAC address object." }, { "info": { "name": "dcim_mac_addresses_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/mac-addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this MAC address." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a MAC address object." }, { "info": { "name": "dcim_mac_addresses_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/mac-addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this MAC address." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a MAC address object." }, { "info": { "name": "dcim_mac_addresses_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/mac-addresses/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this MAC address." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a MAC address object." }, { "info": { "name": "dcim_manufacturers_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/manufacturers/", "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": "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" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of manufacturer objects." }, { "info": { "name": "dcim_manufacturers_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/manufacturers/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of manufacturer objects." }, { "info": { "name": "dcim_manufacturers_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/manufacturers/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of manufacturer objects." }, { "info": { "name": "dcim_manufacturers_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/manufacturers/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of manufacturer objects." }, { "info": { "name": "dcim_manufacturers_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/manufacturers/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of manufacturer objects." }, { "info": { "name": "dcim_manufacturers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/manufacturers/: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 manufacturer." }, { "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 manufacturer object." }, { "info": { "name": "dcim_manufacturers_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/manufacturers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this manufacturer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a manufacturer object." }, { "info": { "name": "dcim_manufacturers_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/manufacturers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this manufacturer." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a manufacturer object." }, { "info": { "name": "dcim_manufacturers_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/manufacturers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this manufacturer." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a manufacturer object." }, { "info": { "name": "dcim_module_bay_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-bay-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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "enabled", "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "position", "value": "", "type": "query" }, { "name": "position__empty", "value": "", "type": "query" }, { "name": "position__ic", "value": "", "type": "query" }, { "name": "position__ie", "value": "", "type": "query" }, { "name": "position__iew", "value": "", "type": "query" }, { "name": "position__iregex", "value": "", "type": "query" }, { "name": "position__isw", "value": "", "type": "query" }, { "name": "position__n", "value": "", "type": "query" }, { "name": "position__nic", "value": "", "type": "query" }, { "name": "position__nie", "value": "", "type": "query" }, { "name": "position__niew", "value": "", "type": "query" }, { "name": "position__nisw", "value": "", "type": "query" }, { "name": "position__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": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of module bay template objects." }, { "info": { "name": "dcim_module_bay_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/module-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of module bay template objects." }, { "info": { "name": "dcim_module_bay_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of module bay template objects." }, { "info": { "name": "dcim_module_bay_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of module bay template objects." }, { "info": { "name": "dcim_module_bay_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-bay-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of module bay template objects." }, { "info": { "name": "dcim_module_bay_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-bay-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 module bay 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 module bay template object." }, { "info": { "name": "dcim_module_bay_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-bay-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module bay template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a module bay template object." }, { "info": { "name": "dcim_module_bay_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-bay-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module bay template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a module bay template object." }, { "info": { "name": "dcim_module_bay_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-bay-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module bay template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a module bay template object." }, { "info": { "name": "dcim_module_bays_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-bays/", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "enabled", "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": "installed_module_id", "value": "", "type": "query", "description": "Installed module (ID)" }, { "name": "installed_module_id__n", "value": "", "type": "query", "description": "Installed module (ID)" }, { "name": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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_id", "value": "", "type": "query", "description": "Parent module bay (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent module bay (ID)" }, { "name": "position", "value": "", "type": "query" }, { "name": "position__empty", "value": "", "type": "query" }, { "name": "position__ic", "value": "", "type": "query" }, { "name": "position__ie", "value": "", "type": "query" }, { "name": "position__iew", "value": "", "type": "query" }, { "name": "position__iregex", "value": "", "type": "query" }, { "name": "position__isw", "value": "", "type": "query" }, { "name": "position__n", "value": "", "type": "query" }, { "name": "position__nic", "value": "", "type": "query" }, { "name": "position__nie", "value": "", "type": "query" }, { "name": "position__niew", "value": "", "type": "query" }, { "name": "position__nisw", "value": "", "type": "query" }, { "name": "position__regex", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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_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_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of module bay objects." }, { "info": { "name": "dcim_module_bays_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/module-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of module bay objects." }, { "info": { "name": "dcim_module_bays_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of module bay objects." }, { "info": { "name": "dcim_module_bays_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of module bay objects." }, { "info": { "name": "dcim_module_bays_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-bays/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of module bay objects." }, { "info": { "name": "dcim_module_bays_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-bays/: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 module bay." }, { "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 module bay object." }, { "info": { "name": "dcim_module_bays_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-bays/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module bay." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a module bay object." }, { "info": { "name": "dcim_module_bays_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-bays/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module bay." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a module bay object." }, { "info": { "name": "dcim_module_bays_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-bays/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module bay." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a module bay object." }, { "info": { "name": "dcim_module_type_profiles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-type-profiles/", "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 module type profile objects." }, { "info": { "name": "dcim_module_type_profiles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/module-type-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of module type profile objects." }, { "info": { "name": "dcim_module_type_profiles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-type-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of module type profile objects." }, { "info": { "name": "dcim_module_type_profiles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-type-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of module type profile objects." }, { "info": { "name": "dcim_module_type_profiles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-type-profiles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of module type profile objects." }, { "info": { "name": "dcim_module_type_profiles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-type-profiles/: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 module type profile." }, { "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 module type profile object." }, { "info": { "name": "dcim_module_type_profiles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-type-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module type profile." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a module type profile object." }, { "info": { "name": "dcim_module_type_profiles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-type-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module type profile." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a module type profile object." }, { "info": { "name": "dcim_module_type_profiles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-type-profiles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module type profile." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a module type profile object." }, { "info": { "name": "dcim_module_types_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-types/", "params": [ { "name": "airflow", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive" }, { "name": "airflow__empty", "value": "", "type": "query" }, { "name": "airflow__ic", "value": "", "type": "query" }, { "name": "airflow__ie", "value": "", "type": "query" }, { "name": "airflow__iew", "value": "", "type": "query" }, { "name": "airflow__iregex", "value": "", "type": "query" }, { "name": "airflow__isw", "value": "", "type": "query" }, { "name": "airflow__n", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front\n* `left-to-right` - Left to right\n* `right-to-left` - Right to left\n* `side-to-rear` - Side to rear\n* `passive` - Passive" }, { "name": "airflow__nic", "value": "", "type": "query" }, { "name": "airflow__nie", "value": "", "type": "query" }, { "name": "airflow__niew", "value": "", "type": "query" }, { "name": "airflow__nisw", "value": "", "type": "query" }, { "name": "airflow__regex", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "console_port_template_count", "value": "", "type": "query" }, { "name": "console_port_template_count__empty", "value": "", "type": "query" }, { "name": "console_port_template_count__gt", "value": "", "type": "query" }, { "name": "console_port_template_count__gte", "value": "", "type": "query" }, { "name": "console_port_template_count__lt", "value": "", "type": "query" }, { "name": "console_port_template_count__lte", "value": "", "type": "query" }, { "name": "console_port_template_count__n", "value": "", "type": "query" }, { "name": "console_ports", "value": "", "type": "query", "description": "Has console ports" }, { "name": "console_server_port_template_count", "value": "", "type": "query" }, { "name": "console_server_port_template_count__empty", "value": "", "type": "query" }, { "name": "console_server_port_template_count__gt", "value": "", "type": "query" }, { "name": "console_server_port_template_count__gte", "value": "", "type": "query" }, { "name": "console_server_port_template_count__lt", "value": "", "type": "query" }, { "name": "console_server_port_template_count__lte", "value": "", "type": "query" }, { "name": "console_server_port_template_count__n", "value": "", "type": "query" }, { "name": "console_server_ports", "value": "", "type": "query", "description": "Has console server ports" }, { "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": "front_port_template_count", "value": "", "type": "query" }, { "name": "front_port_template_count__empty", "value": "", "type": "query" }, { "name": "front_port_template_count__gt", "value": "", "type": "query" }, { "name": "front_port_template_count__gte", "value": "", "type": "query" }, { "name": "front_port_template_count__lt", "value": "", "type": "query" }, { "name": "front_port_template_count__lte", "value": "", "type": "query" }, { "name": "front_port_template_count__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": "interface_template_count", "value": "", "type": "query" }, { "name": "interface_template_count__empty", "value": "", "type": "query" }, { "name": "interface_template_count__gt", "value": "", "type": "query" }, { "name": "interface_template_count__gte", "value": "", "type": "query" }, { "name": "interface_template_count__lt", "value": "", "type": "query" }, { "name": "interface_template_count__lte", "value": "", "type": "query" }, { "name": "interface_template_count__n", "value": "", "type": "query" }, { "name": "interfaces", "value": "", "type": "query", "description": "Has interfaces" }, { "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": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "model", "value": "", "type": "query" }, { "name": "model__empty", "value": "", "type": "query" }, { "name": "model__ic", "value": "", "type": "query" }, { "name": "model__ie", "value": "", "type": "query" }, { "name": "model__iew", "value": "", "type": "query" }, { "name": "model__iregex", "value": "", "type": "query" }, { "name": "model__isw", "value": "", "type": "query" }, { "name": "model__n", "value": "", "type": "query" }, { "name": "model__nic", "value": "", "type": "query" }, { "name": "model__nie", "value": "", "type": "query" }, { "name": "model__niew", "value": "", "type": "query" }, { "name": "model__nisw", "value": "", "type": "query" }, { "name": "model__regex", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_bay_template_count", "value": "", "type": "query" }, { "name": "module_bay_template_count__empty", "value": "", "type": "query" }, { "name": "module_bay_template_count__gt", "value": "", "type": "query" }, { "name": "module_bay_template_count__gte", "value": "", "type": "query" }, { "name": "module_bay_template_count__lt", "value": "", "type": "query" }, { "name": "module_bay_template_count__lte", "value": "", "type": "query" }, { "name": "module_bay_template_count__n", "value": "", "type": "query" }, { "name": "module_bays", "value": "", "type": "query", "description": "Has module bays" }, { "name": "module_count", "value": "", "type": "query" }, { "name": "module_count__empty", "value": "", "type": "query" }, { "name": "module_count__gt", "value": "", "type": "query" }, { "name": "module_count__gte", "value": "", "type": "query" }, { "name": "module_count__lt", "value": "", "type": "query" }, { "name": "module_count__lte", "value": "", "type": "query" }, { "name": "module_count__n", "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": "part_number", "value": "", "type": "query" }, { "name": "part_number__empty", "value": "", "type": "query" }, { "name": "part_number__ic", "value": "", "type": "query" }, { "name": "part_number__ie", "value": "", "type": "query" }, { "name": "part_number__iew", "value": "", "type": "query" }, { "name": "part_number__iregex", "value": "", "type": "query" }, { "name": "part_number__isw", "value": "", "type": "query" }, { "name": "part_number__n", "value": "", "type": "query" }, { "name": "part_number__nic", "value": "", "type": "query" }, { "name": "part_number__nie", "value": "", "type": "query" }, { "name": "part_number__niew", "value": "", "type": "query" }, { "name": "part_number__nisw", "value": "", "type": "query" }, { "name": "part_number__regex", "value": "", "type": "query" }, { "name": "pass_through_ports", "value": "", "type": "query", "description": "Has pass-through ports" }, { "name": "power_outlet_template_count", "value": "", "type": "query" }, { "name": "power_outlet_template_count__empty", "value": "", "type": "query" }, { "name": "power_outlet_template_count__gt", "value": "", "type": "query" }, { "name": "power_outlet_template_count__gte", "value": "", "type": "query" }, { "name": "power_outlet_template_count__lt", "value": "", "type": "query" }, { "name": "power_outlet_template_count__lte", "value": "", "type": "query" }, { "name": "power_outlet_template_count__n", "value": "", "type": "query" }, { "name": "power_outlets", "value": "", "type": "query", "description": "Has power outlets" }, { "name": "power_port_template_count", "value": "", "type": "query" }, { "name": "power_port_template_count__empty", "value": "", "type": "query" }, { "name": "power_port_template_count__gt", "value": "", "type": "query" }, { "name": "power_port_template_count__gte", "value": "", "type": "query" }, { "name": "power_port_template_count__lt", "value": "", "type": "query" }, { "name": "power_port_template_count__lte", "value": "", "type": "query" }, { "name": "power_port_template_count__n", "value": "", "type": "query" }, { "name": "power_ports", "value": "", "type": "query", "description": "Has power ports" }, { "name": "profile", "value": "", "type": "query", "description": "Profile (name)" }, { "name": "profile__n", "value": "", "type": "query", "description": "Profile (name)" }, { "name": "profile_id", "value": "", "type": "query", "description": "Profile (ID)" }, { "name": "profile_id__n", "value": "", "type": "query", "description": "Profile (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rear_port_template_count", "value": "", "type": "query" }, { "name": "rear_port_template_count__empty", "value": "", "type": "query" }, { "name": "rear_port_template_count__gt", "value": "", "type": "query" }, { "name": "rear_port_template_count__gte", "value": "", "type": "query" }, { "name": "rear_port_template_count__lt", "value": "", "type": "query" }, { "name": "rear_port_template_count__lte", "value": "", "type": "query" }, { "name": "rear_port_template_count__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" }, { "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" }, { "name": "weight_unit", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__empty", "value": "", "type": "query" }, { "name": "weight_unit__ic", "value": "", "type": "query" }, { "name": "weight_unit__ie", "value": "", "type": "query" }, { "name": "weight_unit__iew", "value": "", "type": "query" }, { "name": "weight_unit__iregex", "value": "", "type": "query" }, { "name": "weight_unit__isw", "value": "", "type": "query" }, { "name": "weight_unit__n", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__nic", "value": "", "type": "query" }, { "name": "weight_unit__nie", "value": "", "type": "query" }, { "name": "weight_unit__niew", "value": "", "type": "query" }, { "name": "weight_unit__nisw", "value": "", "type": "query" }, { "name": "weight_unit__regex", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of module type objects." }, { "info": { "name": "dcim_module_types_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/module-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of module type objects." }, { "info": { "name": "dcim_module_types_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of module type objects." }, { "info": { "name": "dcim_module_types_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of module type objects." }, { "info": { "name": "dcim_module_types_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of module type objects." }, { "info": { "name": "dcim_module_types_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/module-types/: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 module type." }, { "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 module type object." }, { "info": { "name": "dcim_module_types_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/module-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a module type object." }, { "info": { "name": "dcim_module_types_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/module-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a module type object." }, { "info": { "name": "dcim_module_types_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/module-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module type." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a module type object." }, { "info": { "name": "dcim_modules_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/modules/", "params": [ { "name": "asset_tag", "value": "", "type": "query" }, { "name": "asset_tag__empty", "value": "", "type": "query" }, { "name": "asset_tag__ic", "value": "", "type": "query" }, { "name": "asset_tag__ie", "value": "", "type": "query" }, { "name": "asset_tag__iew", "value": "", "type": "query" }, { "name": "asset_tag__iregex", "value": "", "type": "query" }, { "name": "asset_tag__isw", "value": "", "type": "query" }, { "name": "asset_tag__n", "value": "", "type": "query" }, { "name": "asset_tag__nic", "value": "", "type": "query" }, { "name": "asset_tag__nie", "value": "", "type": "query" }, { "name": "asset_tag__niew", "value": "", "type": "query" }, { "name": "asset_tag__nisw", "value": "", "type": "query" }, { "name": "asset_tag__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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (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": "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_bay_id", "value": "", "type": "query" }, { "name": "module_bay_id__n", "value": "", "type": "query" }, { "name": "module_type", "value": "", "type": "query", "description": "Module type (model)" }, { "name": "module_type__n", "value": "", "type": "query", "description": "Module type (model)" }, { "name": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (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": "profile", "value": "", "type": "query", "description": "Profile (name)" }, { "name": "profile__n", "value": "", "type": "query", "description": "Profile (name)" }, { "name": "profile_id", "value": "", "type": "query", "description": "Profile (ID)" }, { "name": "profile_id__n", "value": "", "type": "query", "description": "Profile (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "serial", "value": "", "type": "query" }, { "name": "serial__empty", "value": "", "type": "query" }, { "name": "serial__ic", "value": "", "type": "query" }, { "name": "serial__ie", "value": "", "type": "query" }, { "name": "serial__iew", "value": "", "type": "query" }, { "name": "serial__iregex", "value": "", "type": "query" }, { "name": "serial__isw", "value": "", "type": "query" }, { "name": "serial__n", "value": "", "type": "query" }, { "name": "serial__nic", "value": "", "type": "query" }, { "name": "serial__nie", "value": "", "type": "query" }, { "name": "serial__niew", "value": "", "type": "query" }, { "name": "serial__nisw", "value": "", "type": "query" }, { "name": "serial__regex", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of module objects." }, { "info": { "name": "dcim_modules_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/modules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of module objects." }, { "info": { "name": "dcim_modules_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/modules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of module objects." }, { "info": { "name": "dcim_modules_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/modules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of module objects." }, { "info": { "name": "dcim_modules_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/modules/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of module objects." }, { "info": { "name": "dcim_modules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/modules/: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 module." }, { "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 module object." }, { "info": { "name": "dcim_modules_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/modules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a module object." }, { "info": { "name": "dcim_modules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/modules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a module object." }, { "info": { "name": "dcim_modules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/modules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this module." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a module object." }, { "info": { "name": "dcim_platforms_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/platforms/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "name": "available_for_device_type", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "config_template_id", "value": "", "type": "query", "description": "Config template (ID)" }, { "name": "config_template_id__n", "value": "", "type": "query", "description": "Config template (ID)" }, { "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": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "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", "value": "", "type": "query", "description": "Immediate parent platform (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Immediate parent platform (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Immediate parent platform (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Immediate parent platform (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 platform objects." }, { "info": { "name": "dcim_platforms_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/platforms/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of platform objects." }, { "info": { "name": "dcim_platforms_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/platforms/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of platform objects." }, { "info": { "name": "dcim_platforms_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/platforms/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of platform objects." }, { "info": { "name": "dcim_platforms_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/platforms/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of platform objects." }, { "info": { "name": "dcim_platforms_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/platforms/: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 platform." }, { "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 platform object." }, { "info": { "name": "dcim_platforms_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/platforms/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this platform." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a platform object." }, { "info": { "name": "dcim_platforms_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/platforms/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this platform." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a platform object." }, { "info": { "name": "dcim_platforms_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/platforms/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this platform." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a platform object." }, { "info": { "name": "dcim_power_feeds_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-feeds/", "params": [ { "name": "amperage", "value": "", "type": "query" }, { "name": "amperage__empty", "value": "", "type": "query" }, { "name": "amperage__gt", "value": "", "type": "query" }, { "name": "amperage__gte", "value": "", "type": "query" }, { "name": "amperage__lt", "value": "", "type": "query" }, { "name": "amperage__lte", "value": "", "type": "query" }, { "name": "amperage__n", "value": "", "type": "query" }, { "name": "available_power", "value": "", "type": "query" }, { "name": "available_power__empty", "value": "", "type": "query" }, { "name": "available_power__gt", "value": "", "type": "query" }, { "name": "available_power__gte", "value": "", "type": "query" }, { "name": "available_power__lt", "value": "", "type": "query" }, { "name": "available_power__lte", "value": "", "type": "query" }, { "name": "available_power__n", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "connected", "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": "mark_connected", "value": "", "type": "query" }, { "name": "max_utilization", "value": "", "type": "query" }, { "name": "max_utilization__empty", "value": "", "type": "query" }, { "name": "max_utilization__gt", "value": "", "type": "query" }, { "name": "max_utilization__gte", "value": "", "type": "query" }, { "name": "max_utilization__lt", "value": "", "type": "query" }, { "name": "max_utilization__lte", "value": "", "type": "query" }, { "name": "max_utilization__n", "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": "occupied", "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": "phase", "value": "", "type": "query", "description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase" }, { "name": "phase__empty", "value": "", "type": "query" }, { "name": "phase__ic", "value": "", "type": "query" }, { "name": "phase__ie", "value": "", "type": "query" }, { "name": "phase__iew", "value": "", "type": "query" }, { "name": "phase__iregex", "value": "", "type": "query" }, { "name": "phase__isw", "value": "", "type": "query" }, { "name": "phase__n", "value": "", "type": "query", "description": "* `single-phase` - Single phase\n* `three-phase` - Three-phase" }, { "name": "phase__nic", "value": "", "type": "query" }, { "name": "phase__nie", "value": "", "type": "query" }, { "name": "phase__niew", "value": "", "type": "query" }, { "name": "phase__nisw", "value": "", "type": "query" }, { "name": "phase__regex", "value": "", "type": "query" }, { "name": "power_panel_id", "value": "", "type": "query", "description": "Power panel (ID)" }, { "name": "power_panel_id__n", "value": "", "type": "query", "description": "Power panel (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "value": "", "type": "query" }, { "name": "supply", "value": "", "type": "query", "description": "* `ac` - AC\n* `dc` - DC" }, { "name": "supply__empty", "value": "", "type": "query" }, { "name": "supply__ic", "value": "", "type": "query" }, { "name": "supply__ie", "value": "", "type": "query" }, { "name": "supply__iew", "value": "", "type": "query" }, { "name": "supply__iregex", "value": "", "type": "query" }, { "name": "supply__isw", "value": "", "type": "query" }, { "name": "supply__n", "value": "", "type": "query", "description": "* `ac` - AC\n* `dc` - DC" }, { "name": "supply__nic", "value": "", "type": "query" }, { "name": "supply__nie", "value": "", "type": "query" }, { "name": "supply__niew", "value": "", "type": "query" }, { "name": "supply__nisw", "value": "", "type": "query" }, { "name": "supply__regex", "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": "type", "value": "", "type": "query", "description": "* `primary` - Primary\n* `redundant` - Redundant" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query", "description": "* `primary` - Primary\n* `redundant` - Redundant" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "voltage", "value": "", "type": "query" }, { "name": "voltage__empty", "value": "", "type": "query" }, { "name": "voltage__gt", "value": "", "type": "query" }, { "name": "voltage__gte", "value": "", "type": "query" }, { "name": "voltage__lt", "value": "", "type": "query" }, { "name": "voltage__lte", "value": "", "type": "query" }, { "name": "voltage__n", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of power feed objects." }, { "info": { "name": "dcim_power_feeds_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/power-feeds/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of power feed objects." }, { "info": { "name": "dcim_power_feeds_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-feeds/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of power feed objects." }, { "info": { "name": "dcim_power_feeds_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-feeds/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of power feed objects." }, { "info": { "name": "dcim_power_feeds_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-feeds/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of power feed objects." }, { "info": { "name": "dcim_power_feeds_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-feeds/: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 power feed." }, { "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 power feed object." }, { "info": { "name": "dcim_power_feeds_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-feeds/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power feed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a power feed object." }, { "info": { "name": "dcim_power_feeds_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-feeds/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power feed." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a power feed object." }, { "info": { "name": "dcim_power_feeds_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-feeds/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power feed." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a power feed object." }, { "info": { "name": "dcim_power_feeds_trace_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-feeds/:id/trace/", "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 power feed." }, { "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": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." }, { "info": { "name": "dcim_power_outlet_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-outlet-templates/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "feed_leg", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__empty", "value": "", "type": "query" }, { "name": "feed_leg__ic", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__ie", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__iew", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__iregex", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__isw", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__n", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__nic", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__nie", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__niew", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__nisw", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__regex", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "power_port_id", "value": "", "type": "query", "description": "Power port (ID)" }, { "name": "power_port_id__n", "value": "", "type": "query", "description": "Power port (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": "type", "value": "", "type": "query", "description": "* `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c17', 'C17'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')]\n* `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')]\n* `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')]\n* `NEMA (Non-locking)` - [('nema-1-15r', 'NEMA 1-15R'), ('nema-5-15r', 'NEMA 5-15R'), ('nema-5-20r', 'NEMA 5-20R'), ('nema-5-30r', 'NEMA 5-30R'), ('nema-5-50r', 'NEMA 5-50R'), ('nema-6-15r', 'NEMA 6-15R'), ('nema-6-20r', 'NEMA 6-20R'), ('nema-6-30r', 'NEMA 6-30R'), ('nema-6-50r', 'NEMA 6-50R'), ('nema-10-30r', 'NEMA 10-30R'), ('nema-10-50r', 'NEMA 10-50R'), ('nema-14-20r', 'NEMA 14-20R'), ('nema-14-30r', 'NEMA 14-30R'), ('nema-14-50r', 'NEMA 14-50R'), ('nema-14-60r', 'NEMA 14-60R'), ('nema-15-15r', 'NEMA 15-15R'), ('nema-15-20r', 'NEMA 15-20R'), ('nema-15-30r', 'NEMA 15-30R'), ('nema-15-50r', 'NEMA 15-50R'), ('nema-15-60r', 'NEMA 15-60R')]\n* `NEMA (Locking)` - [('nema-l1-15r', 'NEMA L1-15R'), ('nema-l5-15r', 'NEMA L5-15R'), ('nema-l5-20r', 'NEMA L5-20R'), ('nema-l5-30r', 'NEMA L5-30R'), ('nema-l5-50r', 'NEMA L5-50R'), ('nema-l6-15r', 'NEMA L6-15R'), ('nema-l6-20r', 'NEMA L6-20R'), ('nema-l6-30r', 'NEMA L6-30R'), ('nema-l6-50r', 'NEMA L6-50R'), ('nema-l10-30r', 'NEMA L10-30R'), ('nema-l14-20r', 'NEMA L14-20R'), ('nema-l14-30r', 'NEMA L14-30R'), ('nema-l14-50r', 'NEMA L14-50R'), ('nema-l14-60r', 'NEMA L14-60R'), ('nema-l15-20r', 'NEMA L15-20R'), ('nema-l15-30r', 'NEMA L15-30R'), ('nema-l15-50r', 'NEMA L15-50R'), ('nema-l15-60r', 'NEMA L15-60R'), ('nema-l21-20r', 'NEMA L21-20R'), ('nema-l21-30r', 'NEMA L21-30R'), ('nema-l22-20r', 'NEMA L22-20R'), ('nema-l22-30r', 'NEMA L22-30R')]\n* `California Style` - [('CS6360C', 'CS6360C'), ('CS6364C', 'CS6364C'), ('CS8164C', 'CS8164C'), ('CS8264C', 'CS8264C'), ('CS8364C', 'CS8364C'), ('CS8464C', 'CS8464C')]\n* `ITA/International` - [('ita-e', 'ITA Type E (CEE 7/5)'), ('ita-f', 'ITA Type F (CEE 7/3)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O'), ('ita-multistandard', 'ITA Multistandard')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-micro-b', 'USB Micro B'), ('usb-c', 'USB Type C')]\n* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')]\n* `DC` - [('dc-terminal', 'DC Terminal')]\n* `Proprietary` - [('eaton-c39', 'Eaton C39'), ('hdot-cx', 'HDOT Cx'), ('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20a', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32a', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')]\n* `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query", "description": "* `IEC 60320` - [('iec-60320-c5', 'C5'), ('iec-60320-c7', 'C7'), ('iec-60320-c13', 'C13'), ('iec-60320-c15', 'C15'), ('iec-60320-c17', 'C17'), ('iec-60320-c19', 'C19'), ('iec-60320-c21', 'C21')]\n* `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')]\n* `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')]\n* `NEMA (Non-locking)` - [('nema-1-15r', 'NEMA 1-15R'), ('nema-5-15r', 'NEMA 5-15R'), ('nema-5-20r', 'NEMA 5-20R'), ('nema-5-30r', 'NEMA 5-30R'), ('nema-5-50r', 'NEMA 5-50R'), ('nema-6-15r', 'NEMA 6-15R'), ('nema-6-20r', 'NEMA 6-20R'), ('nema-6-30r', 'NEMA 6-30R'), ('nema-6-50r', 'NEMA 6-50R'), ('nema-10-30r', 'NEMA 10-30R'), ('nema-10-50r', 'NEMA 10-50R'), ('nema-14-20r', 'NEMA 14-20R'), ('nema-14-30r', 'NEMA 14-30R'), ('nema-14-50r', 'NEMA 14-50R'), ('nema-14-60r', 'NEMA 14-60R'), ('nema-15-15r', 'NEMA 15-15R'), ('nema-15-20r', 'NEMA 15-20R'), ('nema-15-30r', 'NEMA 15-30R'), ('nema-15-50r', 'NEMA 15-50R'), ('nema-15-60r', 'NEMA 15-60R')]\n* `NEMA (Locking)` - [('nema-l1-15r', 'NEMA L1-15R'), ('nema-l5-15r', 'NEMA L5-15R'), ('nema-l5-20r', 'NEMA L5-20R'), ('nema-l5-30r', 'NEMA L5-30R'), ('nema-l5-50r', 'NEMA L5-50R'), ('nema-l6-15r', 'NEMA L6-15R'), ('nema-l6-20r', 'NEMA L6-20R'), ('nema-l6-30r', 'NEMA L6-30R'), ('nema-l6-50r', 'NEMA L6-50R'), ('nema-l10-30r', 'NEMA L10-30R'), ('nema-l14-20r', 'NEMA L14-20R'), ('nema-l14-30r', 'NEMA L14-30R'), ('nema-l14-50r', 'NEMA L14-50R'), ('nema-l14-60r', 'NEMA L14-60R'), ('nema-l15-20r', 'NEMA L15-20R'), ('nema-l15-30r', 'NEMA L15-30R'), ('nema-l15-50r', 'NEMA L15-50R'), ('nema-l15-60r', 'NEMA L15-60R'), ('nema-l21-20r', 'NEMA L21-20R'), ('nema-l21-30r', 'NEMA L21-30R'), ('nema-l22-20r', 'NEMA L22-20R'), ('nema-l22-30r', 'NEMA L22-30R')]\n* `California Style` - [('CS6360C', 'CS6360C'), ('CS6364C', 'CS6364C'), ('CS8164C', 'CS8164C'), ('CS8264C', 'CS8264C'), ('CS8364C', 'CS8364C'), ('CS8464C', 'CS8464C')]\n* `ITA/International` - [('ita-e', 'ITA Type E (CEE 7/5)'), ('ita-f', 'ITA Type F (CEE 7/3)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O'), ('ita-multistandard', 'ITA Multistandard')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-micro-b', 'USB Micro B'), ('usb-c', 'USB Type C')]\n* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')]\n* `DC` - [('dc-terminal', 'DC Terminal')]\n* `Proprietary` - [('eaton-c39', 'Eaton C39'), ('hdot-cx', 'HDOT Cx'), ('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20a', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32a', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')]\n* `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of power outlet template objects." }, { "info": { "name": "dcim_power_outlet_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/power-outlet-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of power outlet template objects." }, { "info": { "name": "dcim_power_outlet_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-outlet-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of power outlet template objects." }, { "info": { "name": "dcim_power_outlet_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-outlet-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of power outlet template objects." }, { "info": { "name": "dcim_power_outlet_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-outlet-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of power outlet template objects." }, { "info": { "name": "dcim_power_outlet_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-outlet-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 power outlet 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 power outlet template object." }, { "info": { "name": "dcim_power_outlet_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-outlet-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power outlet template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a power outlet template object." }, { "info": { "name": "dcim_power_outlet_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-outlet-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power outlet template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a power outlet template object." }, { "info": { "name": "dcim_power_outlet_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-outlet-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power outlet template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a power outlet template object." }, { "info": { "name": "dcim_power_outlets_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-outlets/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "value": "", "type": "query" }, { "name": "connected", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "feed_leg", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__empty", "value": "", "type": "query" }, { "name": "feed_leg__ic", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__ie", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__iew", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__iregex", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__isw", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__n", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__nic", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__nie", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__niew", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__nisw", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "name": "feed_leg__regex", "value": "", "type": "query", "description": "Phase (for three-phase feeds)" }, { "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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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": "occupied", "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": "power_port_id", "value": "", "type": "query", "description": "Power port (ID)" }, { "name": "power_port_id__n", "value": "", "type": "query", "description": "Power port (ID)" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "type", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__ie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iregex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__isw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__n", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__niew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nisw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__regex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of power outlet objects." }, { "info": { "name": "dcim_power_outlets_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/power-outlets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of power outlet objects." }, { "info": { "name": "dcim_power_outlets_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-outlets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of power outlet objects." }, { "info": { "name": "dcim_power_outlets_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-outlets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of power outlet objects." }, { "info": { "name": "dcim_power_outlets_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-outlets/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of power outlet objects." }, { "info": { "name": "dcim_power_outlets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-outlets/: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 power outlet." }, { "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 power outlet object." }, { "info": { "name": "dcim_power_outlets_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-outlets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power outlet." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a power outlet object." }, { "info": { "name": "dcim_power_outlets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-outlets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power outlet." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a power outlet object." }, { "info": { "name": "dcim_power_outlets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-outlets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power outlet." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a power outlet object." }, { "info": { "name": "dcim_power_outlets_trace_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-outlets/:id/trace/", "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 power outlet." }, { "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": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." }, { "info": { "name": "dcim_power_panels_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-panels/", "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": "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_id", "value": "", "type": "query" }, { "name": "location_id__n", "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": "region", "value": "", "type": "query" }, { "name": "region__n", "value": "", "type": "query" }, { "name": "region_id", "value": "", "type": "query" }, { "name": "region_id__n", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of power panel objects." }, { "info": { "name": "dcim_power_panels_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/power-panels/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of power panel objects." }, { "info": { "name": "dcim_power_panels_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-panels/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of power panel objects." }, { "info": { "name": "dcim_power_panels_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-panels/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of power panel objects." }, { "info": { "name": "dcim_power_panels_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-panels/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of power panel objects." }, { "info": { "name": "dcim_power_panels_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-panels/: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 power panel." }, { "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 power panel object." }, { "info": { "name": "dcim_power_panels_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-panels/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power panel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a power panel object." }, { "info": { "name": "dcim_power_panels_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-panels/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power panel." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a power panel object." }, { "info": { "name": "dcim_power_panels_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-panels/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power panel." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a power panel object." }, { "info": { "name": "dcim_power_port_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-port-templates/", "params": [ { "name": "allocated_draw", "value": "", "type": "query" }, { "name": "allocated_draw__empty", "value": "", "type": "query" }, { "name": "allocated_draw__gt", "value": "", "type": "query" }, { "name": "allocated_draw__gte", "value": "", "type": "query" }, { "name": "allocated_draw__lt", "value": "", "type": "query" }, { "name": "allocated_draw__lte", "value": "", "type": "query" }, { "name": "allocated_draw__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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "maximum_draw", "value": "", "type": "query" }, { "name": "maximum_draw__empty", "value": "", "type": "query" }, { "name": "maximum_draw__gt", "value": "", "type": "query" }, { "name": "maximum_draw__gte", "value": "", "type": "query" }, { "name": "maximum_draw__lt", "value": "", "type": "query" }, { "name": "maximum_draw__lte", "value": "", "type": "query" }, { "name": "maximum_draw__n", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "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": "type", "value": "", "type": "query", "description": "* `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c18', 'C18'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')]\n* `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')]\n* `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')]\n* `NEMA (Non-locking)` - [('nema-1-15p', 'NEMA 1-15P'), ('nema-5-15p', 'NEMA 5-15P'), ('nema-5-20p', 'NEMA 5-20P'), ('nema-5-30p', 'NEMA 5-30P'), ('nema-5-50p', 'NEMA 5-50P'), ('nema-6-15p', 'NEMA 6-15P'), ('nema-6-20p', 'NEMA 6-20P'), ('nema-6-30p', 'NEMA 6-30P'), ('nema-6-50p', 'NEMA 6-50P'), ('nema-10-30p', 'NEMA 10-30P'), ('nema-10-50p', 'NEMA 10-50P'), ('nema-14-20p', 'NEMA 14-20P'), ('nema-14-30p', 'NEMA 14-30P'), ('nema-14-50p', 'NEMA 14-50P'), ('nema-14-60p', 'NEMA 14-60P'), ('nema-15-15p', 'NEMA 15-15P'), ('nema-15-20p', 'NEMA 15-20P'), ('nema-15-30p', 'NEMA 15-30P'), ('nema-15-50p', 'NEMA 15-50P'), ('nema-15-60p', 'NEMA 15-60P')]\n* `NEMA (Locking)` - [('nema-l1-15p', 'NEMA L1-15P'), ('nema-l5-15p', 'NEMA L5-15P'), ('nema-l5-20p', 'NEMA L5-20P'), ('nema-l5-30p', 'NEMA L5-30P'), ('nema-l5-50p', 'NEMA L5-50P'), ('nema-l6-15p', 'NEMA L6-15P'), ('nema-l6-20p', 'NEMA L6-20P'), ('nema-l6-30p', 'NEMA L6-30P'), ('nema-l6-50p', 'NEMA L6-50P'), ('nema-l10-30p', 'NEMA L10-30P'), ('nema-l14-20p', 'NEMA L14-20P'), ('nema-l14-30p', 'NEMA L14-30P'), ('nema-l14-50p', 'NEMA L14-50P'), ('nema-l14-60p', 'NEMA L14-60P'), ('nema-l15-20p', 'NEMA L15-20P'), ('nema-l15-30p', 'NEMA L15-30P'), ('nema-l15-50p', 'NEMA L15-50P'), ('nema-l15-60p', 'NEMA L15-60P'), ('nema-l21-20p', 'NEMA L21-20P'), ('nema-l21-30p', 'NEMA L21-30P'), ('nema-l22-20p', 'NEMA L22-20P'), ('nema-l22-30p', 'NEMA L22-30P')]\n* `California Style` - [('cs6361c', 'CS6361C'), ('cs6365c', 'CS6365C'), ('cs8165c', 'CS8165C'), ('cs8265c', 'CS8265C'), ('cs8365c', 'CS8365C'), ('cs8465c', 'CS8465C')]\n* `International/ITA` - [('ita-c', 'ITA Type C (CEE 7/16)'), ('ita-e', 'ITA Type E (CEE 7/6)'), ('ita-f', 'ITA Type F (CEE 7/4)'), ('ita-ef', 'ITA Type E/F (CEE 7/7)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB'), ('usb-3-b', 'USB 3.0 Type B'), ('usb-3-micro-b', 'USB 3.0 Micro B')]\n* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')]\n* `DC` - [('dc-terminal', 'DC Terminal')]\n* `Proprietary` - [('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')]\n* `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query", "description": "* `IEC 60320` - [('iec-60320-c6', 'C6'), ('iec-60320-c8', 'C8'), ('iec-60320-c14', 'C14'), ('iec-60320-c16', 'C16'), ('iec-60320-c18', 'C18'), ('iec-60320-c20', 'C20'), ('iec-60320-c22', 'C22')]\n* `IEC 60309` - [('iec-60309-p-n-e-4h', 'P+N+E 4H'), ('iec-60309-p-n-e-6h', 'P+N+E 6H'), ('iec-60309-p-n-e-9h', 'P+N+E 9H'), ('iec-60309-2p-e-4h', '2P+E 4H'), ('iec-60309-2p-e-6h', '2P+E 6H'), ('iec-60309-2p-e-9h', '2P+E 9H'), ('iec-60309-3p-e-4h', '3P+E 4H'), ('iec-60309-3p-e-6h', '3P+E 6H'), ('iec-60309-3p-e-9h', '3P+E 9H'), ('iec-60309-3p-n-e-4h', '3P+N+E 4H'), ('iec-60309-3p-n-e-6h', '3P+N+E 6H'), ('iec-60309-3p-n-e-9h', '3P+N+E 9H')]\n* `IEC 60906-1` - [('iec-60906-1', 'IEC 60906-1'), ('nbr-14136-10a', '2P+T 10A (NBR 14136)'), ('nbr-14136-20a', '2P+T 20A (NBR 14136)')]\n* `NEMA (Non-locking)` - [('nema-1-15p', 'NEMA 1-15P'), ('nema-5-15p', 'NEMA 5-15P'), ('nema-5-20p', 'NEMA 5-20P'), ('nema-5-30p', 'NEMA 5-30P'), ('nema-5-50p', 'NEMA 5-50P'), ('nema-6-15p', 'NEMA 6-15P'), ('nema-6-20p', 'NEMA 6-20P'), ('nema-6-30p', 'NEMA 6-30P'), ('nema-6-50p', 'NEMA 6-50P'), ('nema-10-30p', 'NEMA 10-30P'), ('nema-10-50p', 'NEMA 10-50P'), ('nema-14-20p', 'NEMA 14-20P'), ('nema-14-30p', 'NEMA 14-30P'), ('nema-14-50p', 'NEMA 14-50P'), ('nema-14-60p', 'NEMA 14-60P'), ('nema-15-15p', 'NEMA 15-15P'), ('nema-15-20p', 'NEMA 15-20P'), ('nema-15-30p', 'NEMA 15-30P'), ('nema-15-50p', 'NEMA 15-50P'), ('nema-15-60p', 'NEMA 15-60P')]\n* `NEMA (Locking)` - [('nema-l1-15p', 'NEMA L1-15P'), ('nema-l5-15p', 'NEMA L5-15P'), ('nema-l5-20p', 'NEMA L5-20P'), ('nema-l5-30p', 'NEMA L5-30P'), ('nema-l5-50p', 'NEMA L5-50P'), ('nema-l6-15p', 'NEMA L6-15P'), ('nema-l6-20p', 'NEMA L6-20P'), ('nema-l6-30p', 'NEMA L6-30P'), ('nema-l6-50p', 'NEMA L6-50P'), ('nema-l10-30p', 'NEMA L10-30P'), ('nema-l14-20p', 'NEMA L14-20P'), ('nema-l14-30p', 'NEMA L14-30P'), ('nema-l14-50p', 'NEMA L14-50P'), ('nema-l14-60p', 'NEMA L14-60P'), ('nema-l15-20p', 'NEMA L15-20P'), ('nema-l15-30p', 'NEMA L15-30P'), ('nema-l15-50p', 'NEMA L15-50P'), ('nema-l15-60p', 'NEMA L15-60P'), ('nema-l21-20p', 'NEMA L21-20P'), ('nema-l21-30p', 'NEMA L21-30P'), ('nema-l22-20p', 'NEMA L22-20P'), ('nema-l22-30p', 'NEMA L22-30P')]\n* `California Style` - [('cs6361c', 'CS6361C'), ('cs6365c', 'CS6365C'), ('cs8165c', 'CS8165C'), ('cs8265c', 'CS8265C'), ('cs8365c', 'CS8365C'), ('cs8465c', 'CS8465C')]\n* `International/ITA` - [('ita-c', 'ITA Type C (CEE 7/16)'), ('ita-e', 'ITA Type E (CEE 7/6)'), ('ita-f', 'ITA Type F (CEE 7/4)'), ('ita-ef', 'ITA Type E/F (CEE 7/7)'), ('ita-g', 'ITA Type G (BS 1363)'), ('ita-h', 'ITA Type H'), ('ita-i', 'ITA Type I'), ('ita-j', 'ITA Type J'), ('ita-k', 'ITA Type K'), ('ita-l', 'ITA Type L (CEI 23-50)'), ('ita-m', 'ITA Type M (BS 546)'), ('ita-n', 'ITA Type N'), ('ita-o', 'ITA Type O')]\n* `USB` - [('usb-a', 'USB Type A'), ('usb-b', 'USB Type B'), ('usb-c', 'USB Type C'), ('usb-mini-a', 'USB Mini A'), ('usb-mini-b', 'USB Mini B'), ('usb-micro-a', 'USB Micro A'), ('usb-micro-b', 'USB Micro B'), ('usb-micro-ab', 'USB Micro AB'), ('usb-3-b', 'USB 3.0 Type B'), ('usb-3-micro-b', 'USB 3.0 Micro B')]\n* `Molex` - [('molex-micro-fit-1x2', 'Molex Micro-Fit 1x2'), ('molex-micro-fit-2x2', 'Molex Micro-Fit 2x2'), ('molex-micro-fit-2x3', 'Molex Micro-Fit 2x3'), ('molex-micro-fit-2x4', 'Molex Micro-Fit 2x4')]\n* `DC` - [('dc-terminal', 'DC Terminal')]\n* `Proprietary` - [('saf-d-grid', 'Saf-D-Grid'), ('neutrik-powercon-20', 'Neutrik powerCON (20A)'), ('neutrik-powercon-32', 'Neutrik powerCON (32A)'), ('neutrik-powercon-true1', 'Neutrik powerCON TRUE1'), ('neutrik-powercon-true1-top', 'Neutrik powerCON TRUE1 TOP'), ('ubiquiti-smartpower', 'Ubiquiti SmartPower')]\n* `Other` - [('hardwired', 'Hardwired'), ('other', 'Other')]" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of power port template objects." }, { "info": { "name": "dcim_power_port_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/power-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of power port template objects." }, { "info": { "name": "dcim_power_port_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of power port template objects." }, { "info": { "name": "dcim_power_port_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of power port template objects." }, { "info": { "name": "dcim_power_port_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of power port template objects." }, { "info": { "name": "dcim_power_port_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-port-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 power port 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 power port template object." }, { "info": { "name": "dcim_power_port_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a power port template object." }, { "info": { "name": "dcim_power_port_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a power port template object." }, { "info": { "name": "dcim_power_port_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power port template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a power port template object." }, { "info": { "name": "dcim_power_ports_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-ports/", "params": [ { "name": "allocated_draw", "value": "", "type": "query" }, { "name": "allocated_draw__empty", "value": "", "type": "query" }, { "name": "allocated_draw__gt", "value": "", "type": "query" }, { "name": "allocated_draw__gte", "value": "", "type": "query" }, { "name": "allocated_draw__lt", "value": "", "type": "query" }, { "name": "allocated_draw__lte", "value": "", "type": "query" }, { "name": "allocated_draw__n", "value": "", "type": "query" }, { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "connected", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "maximum_draw", "value": "", "type": "query" }, { "name": "maximum_draw__empty", "value": "", "type": "query" }, { "name": "maximum_draw__gt", "value": "", "type": "query" }, { "name": "maximum_draw__gte", "value": "", "type": "query" }, { "name": "maximum_draw__lt", "value": "", "type": "query" }, { "name": "maximum_draw__lte", "value": "", "type": "query" }, { "name": "maximum_draw__n", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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": "occupied", "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", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "type", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__ie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__iregex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__isw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__n", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nic", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nie", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__niew", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__nisw", "value": "", "type": "query", "description": "Physical port type" }, { "name": "type__regex", "value": "", "type": "query", "description": "Physical port type" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of power port objects." }, { "info": { "name": "dcim_power_ports_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/power-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of power port objects." }, { "info": { "name": "dcim_power_ports_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of power port objects." }, { "info": { "name": "dcim_power_ports_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of power port objects." }, { "info": { "name": "dcim_power_ports_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of power port objects." }, { "info": { "name": "dcim_power_ports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-ports/: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 power port." }, { "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 power port object." }, { "info": { "name": "dcim_power_ports_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/power-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a power port object." }, { "info": { "name": "dcim_power_ports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/power-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a power port object." }, { "info": { "name": "dcim_power_ports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/power-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this power port." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a power port object." }, { "info": { "name": "dcim_power_ports_trace_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/power-ports/:id/trace/", "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 power port." }, { "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": "Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination)." }, { "info": { "name": "dcim_rack_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-groups/", "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" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of rack group objects." }, { "info": { "name": "dcim_rack_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/rack-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rack group objects." }, { "info": { "name": "dcim_rack_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rack group objects." }, { "info": { "name": "dcim_rack_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rack group objects." }, { "info": { "name": "dcim_rack_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rack group objects." }, { "info": { "name": "dcim_rack_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-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 rack 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 rack group object." }, { "info": { "name": "dcim_rack_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rack group object." }, { "info": { "name": "dcim_rack_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rack group object." }, { "info": { "name": "dcim_rack_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rack group object." }, { "info": { "name": "dcim_rack_reservations_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-reservations/", "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": "group", "value": "", "type": "query", "description": "Group (slug)" }, { "name": "group__n", "value": "", "type": "query", "description": "Group (slug)" }, { "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": "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": "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": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "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" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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": "unit", "value": "", "type": "query" }, { "name": "unit__empty", "value": "", "type": "query" }, { "name": "unit__gt", "value": "", "type": "query" }, { "name": "unit__gte", "value": "", "type": "query" }, { "name": "unit__lt", "value": "", "type": "query" }, { "name": "unit__lte", "value": "", "type": "query" }, { "name": "unit__n", "value": "", "type": "query" }, { "name": "unit_count_max", "value": "", "type": "query", "description": "Maximum unit count" }, { "name": "unit_count_min", "value": "", "type": "query", "description": "Minimum unit count" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query", "description": "User (name)" }, { "name": "user__n", "value": "", "type": "query", "description": "User (name)" }, { "name": "user_id", "value": "", "type": "query", "description": "User (ID)" }, { "name": "user_id__n", "value": "", "type": "query", "description": "User (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of rack reservation objects." }, { "info": { "name": "dcim_rack_reservations_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/rack-reservations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rack reservation objects." }, { "info": { "name": "dcim_rack_reservations_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-reservations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rack reservation objects." }, { "info": { "name": "dcim_rack_reservations_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-reservations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rack reservation objects." }, { "info": { "name": "dcim_rack_reservations_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-reservations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rack reservation objects." }, { "info": { "name": "dcim_rack_reservations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-reservations/: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 rack reservation." }, { "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 rack reservation object." }, { "info": { "name": "dcim_rack_reservations_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-reservations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack reservation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rack reservation object." }, { "info": { "name": "dcim_rack_reservations_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-reservations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack reservation." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rack reservation object." }, { "info": { "name": "dcim_rack_reservations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-reservations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack reservation." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rack reservation object." }, { "info": { "name": "dcim_rack_roles_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-roles/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "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 rack role objects." }, { "info": { "name": "dcim_rack_roles_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/rack-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rack role objects." }, { "info": { "name": "dcim_rack_roles_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rack role objects." }, { "info": { "name": "dcim_rack_roles_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rack role objects." }, { "info": { "name": "dcim_rack_roles_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-roles/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rack role objects." }, { "info": { "name": "dcim_rack_roles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-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 rack 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 rack role object." }, { "info": { "name": "dcim_rack_roles_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rack role object." }, { "info": { "name": "dcim_rack_roles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack role." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rack role object." }, { "info": { "name": "dcim_rack_roles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack role." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rack role object." }, { "info": { "name": "dcim_rack_types_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-types/", "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": "desc_units", "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": "form_factor", "value": "", "type": "query" }, { "name": "form_factor__empty", "value": "", "type": "query" }, { "name": "form_factor__ic", "value": "", "type": "query" }, { "name": "form_factor__ie", "value": "", "type": "query" }, { "name": "form_factor__iew", "value": "", "type": "query" }, { "name": "form_factor__iregex", "value": "", "type": "query" }, { "name": "form_factor__isw", "value": "", "type": "query" }, { "name": "form_factor__n", "value": "", "type": "query" }, { "name": "form_factor__nic", "value": "", "type": "query" }, { "name": "form_factor__nie", "value": "", "type": "query" }, { "name": "form_factor__niew", "value": "", "type": "query" }, { "name": "form_factor__nisw", "value": "", "type": "query" }, { "name": "form_factor__regex", "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": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "max_weight", "value": "", "type": "query" }, { "name": "max_weight__empty", "value": "", "type": "query" }, { "name": "max_weight__gt", "value": "", "type": "query" }, { "name": "max_weight__gte", "value": "", "type": "query" }, { "name": "max_weight__lt", "value": "", "type": "query" }, { "name": "max_weight__lte", "value": "", "type": "query" }, { "name": "max_weight__n", "value": "", "type": "query" }, { "name": "model", "value": "", "type": "query" }, { "name": "model__empty", "value": "", "type": "query" }, { "name": "model__ic", "value": "", "type": "query" }, { "name": "model__ie", "value": "", "type": "query" }, { "name": "model__iew", "value": "", "type": "query" }, { "name": "model__iregex", "value": "", "type": "query" }, { "name": "model__isw", "value": "", "type": "query" }, { "name": "model__n", "value": "", "type": "query" }, { "name": "model__nic", "value": "", "type": "query" }, { "name": "model__nie", "value": "", "type": "query" }, { "name": "model__niew", "value": "", "type": "query" }, { "name": "model__nisw", "value": "", "type": "query" }, { "name": "model__regex", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "mounting_depth", "value": "", "type": "query" }, { "name": "mounting_depth__empty", "value": "", "type": "query" }, { "name": "mounting_depth__gt", "value": "", "type": "query" }, { "name": "mounting_depth__gte", "value": "", "type": "query" }, { "name": "mounting_depth__lt", "value": "", "type": "query" }, { "name": "mounting_depth__lte", "value": "", "type": "query" }, { "name": "mounting_depth__n", "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": "outer_depth", "value": "", "type": "query" }, { "name": "outer_depth__empty", "value": "", "type": "query" }, { "name": "outer_depth__gt", "value": "", "type": "query" }, { "name": "outer_depth__gte", "value": "", "type": "query" }, { "name": "outer_depth__lt", "value": "", "type": "query" }, { "name": "outer_depth__lte", "value": "", "type": "query" }, { "name": "outer_depth__n", "value": "", "type": "query" }, { "name": "outer_height", "value": "", "type": "query" }, { "name": "outer_height__empty", "value": "", "type": "query" }, { "name": "outer_height__gt", "value": "", "type": "query" }, { "name": "outer_height__gte", "value": "", "type": "query" }, { "name": "outer_height__lt", "value": "", "type": "query" }, { "name": "outer_height__lte", "value": "", "type": "query" }, { "name": "outer_height__n", "value": "", "type": "query" }, { "name": "outer_unit", "value": "", "type": "query", "description": "* `mm` - Millimeters\n* `in` - Inches" }, { "name": "outer_unit__empty", "value": "", "type": "query" }, { "name": "outer_unit__ic", "value": "", "type": "query" }, { "name": "outer_unit__ie", "value": "", "type": "query" }, { "name": "outer_unit__iew", "value": "", "type": "query" }, { "name": "outer_unit__iregex", "value": "", "type": "query" }, { "name": "outer_unit__isw", "value": "", "type": "query" }, { "name": "outer_unit__n", "value": "", "type": "query", "description": "* `mm` - Millimeters\n* `in` - Inches" }, { "name": "outer_unit__nic", "value": "", "type": "query" }, { "name": "outer_unit__nie", "value": "", "type": "query" }, { "name": "outer_unit__niew", "value": "", "type": "query" }, { "name": "outer_unit__nisw", "value": "", "type": "query" }, { "name": "outer_unit__regex", "value": "", "type": "query" }, { "name": "outer_width", "value": "", "type": "query" }, { "name": "outer_width__empty", "value": "", "type": "query" }, { "name": "outer_width__gt", "value": "", "type": "query" }, { "name": "outer_width__gte", "value": "", "type": "query" }, { "name": "outer_width__lt", "value": "", "type": "query" }, { "name": "outer_width__lte", "value": "", "type": "query" }, { "name": "outer_width__n", "value": "", "type": "query" }, { "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_count", "value": "", "type": "query" }, { "name": "rack_count__empty", "value": "", "type": "query" }, { "name": "rack_count__gt", "value": "", "type": "query" }, { "name": "rack_count__gte", "value": "", "type": "query" }, { "name": "rack_count__lt", "value": "", "type": "query" }, { "name": "rack_count__lte", "value": "", "type": "query" }, { "name": "rack_count__n", "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": "starting_unit", "value": "", "type": "query" }, { "name": "starting_unit__empty", "value": "", "type": "query" }, { "name": "starting_unit__gt", "value": "", "type": "query" }, { "name": "starting_unit__gte", "value": "", "type": "query" }, { "name": "starting_unit__lt", "value": "", "type": "query" }, { "name": "starting_unit__lte", "value": "", "type": "query" }, { "name": "starting_unit__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": "u_height", "value": "", "type": "query" }, { "name": "u_height__empty", "value": "", "type": "query" }, { "name": "u_height__gt", "value": "", "type": "query" }, { "name": "u_height__gte", "value": "", "type": "query" }, { "name": "u_height__lt", "value": "", "type": "query" }, { "name": "u_height__lte", "value": "", "type": "query" }, { "name": "u_height__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" }, { "name": "weight_unit", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__empty", "value": "", "type": "query" }, { "name": "weight_unit__ic", "value": "", "type": "query" }, { "name": "weight_unit__ie", "value": "", "type": "query" }, { "name": "weight_unit__iew", "value": "", "type": "query" }, { "name": "weight_unit__iregex", "value": "", "type": "query" }, { "name": "weight_unit__isw", "value": "", "type": "query" }, { "name": "weight_unit__n", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__nic", "value": "", "type": "query" }, { "name": "weight_unit__nie", "value": "", "type": "query" }, { "name": "weight_unit__niew", "value": "", "type": "query" }, { "name": "weight_unit__nisw", "value": "", "type": "query" }, { "name": "weight_unit__regex", "value": "", "type": "query" }, { "name": "width", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__ic", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__ie", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__iew", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__iregex", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__isw", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__n", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__nic", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__nie", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__niew", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__nisw", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__regex", "value": "", "type": "query", "description": "Rail-to-rail width" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of rack type objects." }, { "info": { "name": "dcim_rack_types_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/rack-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rack type objects." }, { "info": { "name": "dcim_rack_types_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rack type objects." }, { "info": { "name": "dcim_rack_types_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rack type objects." }, { "info": { "name": "dcim_rack_types_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-types/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rack type objects." }, { "info": { "name": "dcim_rack_types_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rack-types/: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 rack type." }, { "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 rack type object." }, { "info": { "name": "dcim_rack_types_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rack-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rack type object." }, { "info": { "name": "dcim_rack_types_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rack-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack type." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rack type object." }, { "info": { "name": "dcim_rack_types_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rack-types/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack type." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rack type object." }, { "info": { "name": "dcim_racks_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/racks/", "params": [ { "name": "airflow", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front" }, { "name": "airflow__empty", "value": "", "type": "query" }, { "name": "airflow__ic", "value": "", "type": "query" }, { "name": "airflow__ie", "value": "", "type": "query" }, { "name": "airflow__iew", "value": "", "type": "query" }, { "name": "airflow__iregex", "value": "", "type": "query" }, { "name": "airflow__isw", "value": "", "type": "query" }, { "name": "airflow__n", "value": "", "type": "query", "description": "* `front-to-rear` - Front to rear\n* `rear-to-front` - Rear to front" }, { "name": "airflow__nic", "value": "", "type": "query" }, { "name": "airflow__nie", "value": "", "type": "query" }, { "name": "airflow__niew", "value": "", "type": "query" }, { "name": "airflow__nisw", "value": "", "type": "query" }, { "name": "airflow__regex", "value": "", "type": "query" }, { "name": "asset_tag", "value": "", "type": "query" }, { "name": "asset_tag__empty", "value": "", "type": "query" }, { "name": "asset_tag__ic", "value": "", "type": "query" }, { "name": "asset_tag__ie", "value": "", "type": "query" }, { "name": "asset_tag__iew", "value": "", "type": "query" }, { "name": "asset_tag__iregex", "value": "", "type": "query" }, { "name": "asset_tag__isw", "value": "", "type": "query" }, { "name": "asset_tag__n", "value": "", "type": "query" }, { "name": "asset_tag__nic", "value": "", "type": "query" }, { "name": "asset_tag__nie", "value": "", "type": "query" }, { "name": "asset_tag__niew", "value": "", "type": "query" }, { "name": "asset_tag__nisw", "value": "", "type": "query" }, { "name": "asset_tag__regex", "value": "", "type": "query" }, { "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": "desc_units", "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": "facility_id", "value": "", "type": "query" }, { "name": "facility_id__empty", "value": "", "type": "query" }, { "name": "facility_id__ic", "value": "", "type": "query" }, { "name": "facility_id__ie", "value": "", "type": "query" }, { "name": "facility_id__iew", "value": "", "type": "query" }, { "name": "facility_id__iregex", "value": "", "type": "query" }, { "name": "facility_id__isw", "value": "", "type": "query" }, { "name": "facility_id__n", "value": "", "type": "query" }, { "name": "facility_id__nic", "value": "", "type": "query" }, { "name": "facility_id__nie", "value": "", "type": "query" }, { "name": "facility_id__niew", "value": "", "type": "query" }, { "name": "facility_id__nisw", "value": "", "type": "query" }, { "name": "facility_id__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": "form_factor", "value": "", "type": "query" }, { "name": "form_factor__empty", "value": "", "type": "query" }, { "name": "form_factor__ic", "value": "", "type": "query" }, { "name": "form_factor__ie", "value": "", "type": "query" }, { "name": "form_factor__iew", "value": "", "type": "query" }, { "name": "form_factor__iregex", "value": "", "type": "query" }, { "name": "form_factor__isw", "value": "", "type": "query" }, { "name": "form_factor__n", "value": "", "type": "query" }, { "name": "form_factor__nic", "value": "", "type": "query" }, { "name": "form_factor__nie", "value": "", "type": "query" }, { "name": "form_factor__niew", "value": "", "type": "query" }, { "name": "form_factor__nisw", "value": "", "type": "query" }, { "name": "form_factor__regex", "value": "", "type": "query" }, { "name": "group", "value": "", "type": "query", "description": "Group (slug)" }, { "name": "group__n", "value": "", "type": "query", "description": "Group (slug)" }, { "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": "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": "manufacturer", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer__n", "value": "", "type": "query", "description": "Manufacturer (slug)" }, { "name": "manufacturer_id", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "manufacturer_id__n", "value": "", "type": "query", "description": "Manufacturer (ID)" }, { "name": "max_weight", "value": "", "type": "query" }, { "name": "max_weight__empty", "value": "", "type": "query" }, { "name": "max_weight__gt", "value": "", "type": "query" }, { "name": "max_weight__gte", "value": "", "type": "query" }, { "name": "max_weight__lt", "value": "", "type": "query" }, { "name": "max_weight__lte", "value": "", "type": "query" }, { "name": "max_weight__n", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "mounting_depth", "value": "", "type": "query" }, { "name": "mounting_depth__empty", "value": "", "type": "query" }, { "name": "mounting_depth__gt", "value": "", "type": "query" }, { "name": "mounting_depth__gte", "value": "", "type": "query" }, { "name": "mounting_depth__lt", "value": "", "type": "query" }, { "name": "mounting_depth__lte", "value": "", "type": "query" }, { "name": "mounting_depth__n", "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": "outer_depth", "value": "", "type": "query" }, { "name": "outer_depth__empty", "value": "", "type": "query" }, { "name": "outer_depth__gt", "value": "", "type": "query" }, { "name": "outer_depth__gte", "value": "", "type": "query" }, { "name": "outer_depth__lt", "value": "", "type": "query" }, { "name": "outer_depth__lte", "value": "", "type": "query" }, { "name": "outer_depth__n", "value": "", "type": "query" }, { "name": "outer_height", "value": "", "type": "query" }, { "name": "outer_height__empty", "value": "", "type": "query" }, { "name": "outer_height__gt", "value": "", "type": "query" }, { "name": "outer_height__gte", "value": "", "type": "query" }, { "name": "outer_height__lt", "value": "", "type": "query" }, { "name": "outer_height__lte", "value": "", "type": "query" }, { "name": "outer_height__n", "value": "", "type": "query" }, { "name": "outer_unit", "value": "", "type": "query", "description": "* `mm` - Millimeters\n* `in` - Inches" }, { "name": "outer_unit__empty", "value": "", "type": "query" }, { "name": "outer_unit__ic", "value": "", "type": "query" }, { "name": "outer_unit__ie", "value": "", "type": "query" }, { "name": "outer_unit__iew", "value": "", "type": "query" }, { "name": "outer_unit__iregex", "value": "", "type": "query" }, { "name": "outer_unit__isw", "value": "", "type": "query" }, { "name": "outer_unit__n", "value": "", "type": "query", "description": "* `mm` - Millimeters\n* `in` - Inches" }, { "name": "outer_unit__nic", "value": "", "type": "query" }, { "name": "outer_unit__nie", "value": "", "type": "query" }, { "name": "outer_unit__niew", "value": "", "type": "query" }, { "name": "outer_unit__nisw", "value": "", "type": "query" }, { "name": "outer_unit__regex", "value": "", "type": "query" }, { "name": "outer_width", "value": "", "type": "query" }, { "name": "outer_width__empty", "value": "", "type": "query" }, { "name": "outer_width__gt", "value": "", "type": "query" }, { "name": "outer_width__gte", "value": "", "type": "query" }, { "name": "outer_width__lt", "value": "", "type": "query" }, { "name": "outer_width__lte", "value": "", "type": "query" }, { "name": "outer_width__n", "value": "", "type": "query" }, { "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_type", "value": "", "type": "query", "description": "Rack type (slug)" }, { "name": "rack_type__n", "value": "", "type": "query", "description": "Rack type (slug)" }, { "name": "rack_type_id", "value": "", "type": "query", "description": "Rack type (ID)" }, { "name": "rack_type_id__n", "value": "", "type": "query", "description": "Rack type (ID)" }, { "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": "serial", "value": "", "type": "query" }, { "name": "serial__empty", "value": "", "type": "query" }, { "name": "serial__ic", "value": "", "type": "query" }, { "name": "serial__ie", "value": "", "type": "query" }, { "name": "serial__iew", "value": "", "type": "query" }, { "name": "serial__iregex", "value": "", "type": "query" }, { "name": "serial__isw", "value": "", "type": "query" }, { "name": "serial__n", "value": "", "type": "query" }, { "name": "serial__nic", "value": "", "type": "query" }, { "name": "serial__nie", "value": "", "type": "query" }, { "name": "serial__niew", "value": "", "type": "query" }, { "name": "serial__nisw", "value": "", "type": "query" }, { "name": "serial__regex", "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": "starting_unit", "value": "", "type": "query" }, { "name": "starting_unit__empty", "value": "", "type": "query" }, { "name": "starting_unit__gt", "value": "", "type": "query" }, { "name": "starting_unit__gte", "value": "", "type": "query" }, { "name": "starting_unit__lt", "value": "", "type": "query" }, { "name": "starting_unit__lte", "value": "", "type": "query" }, { "name": "starting_unit__n", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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": "u_height", "value": "", "type": "query" }, { "name": "u_height__empty", "value": "", "type": "query" }, { "name": "u_height__gt", "value": "", "type": "query" }, { "name": "u_height__gte", "value": "", "type": "query" }, { "name": "u_height__lt", "value": "", "type": "query" }, { "name": "u_height__lte", "value": "", "type": "query" }, { "name": "u_height__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" }, { "name": "weight_unit", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__empty", "value": "", "type": "query" }, { "name": "weight_unit__ic", "value": "", "type": "query" }, { "name": "weight_unit__ie", "value": "", "type": "query" }, { "name": "weight_unit__iew", "value": "", "type": "query" }, { "name": "weight_unit__iregex", "value": "", "type": "query" }, { "name": "weight_unit__isw", "value": "", "type": "query" }, { "name": "weight_unit__n", "value": "", "type": "query", "description": "* `kg` - Kilograms\n* `g` - Grams\n* `lb` - Pounds\n* `oz` - Ounces" }, { "name": "weight_unit__nic", "value": "", "type": "query" }, { "name": "weight_unit__nie", "value": "", "type": "query" }, { "name": "weight_unit__niew", "value": "", "type": "query" }, { "name": "weight_unit__nisw", "value": "", "type": "query" }, { "name": "weight_unit__regex", "value": "", "type": "query" }, { "name": "width", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__ic", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__ie", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__iew", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__iregex", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__isw", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__n", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__nic", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__nie", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__niew", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__nisw", "value": "", "type": "query", "description": "Rail-to-rail width" }, { "name": "width__regex", "value": "", "type": "query", "description": "Rail-to-rail width" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of rack objects." }, { "info": { "name": "dcim_racks_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/racks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rack objects." }, { "info": { "name": "dcim_racks_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/racks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rack objects." }, { "info": { "name": "dcim_racks_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/racks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rack objects." }, { "info": { "name": "dcim_racks_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/racks/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rack objects." }, { "info": { "name": "dcim_racks_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/racks/: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 rack." }, { "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 rack object." }, { "info": { "name": "dcim_racks_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/racks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rack object." }, { "info": { "name": "dcim_racks_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/racks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rack object." }, { "info": { "name": "dcim_racks_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/racks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rack." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rack object." }, { "info": { "name": "dcim_racks_elevation_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/racks/:id/elevation/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "exclude", "value": "", "type": "query" }, { "name": "expand_devices", "value": "", "type": "query" }, { "name": "face", "value": "", "type": "query", "description": "* `front` - Front\n* `rear` - Rear" }, { "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 rack." }, { "name": "include_images", "value": "", "type": "query" }, { "name": "legend_width", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "margin_width", "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": "q", "value": "", "type": "query" }, { "name": "render", "value": "", "type": "query", "description": "* `json` - json\n* `svg` - svg" }, { "name": "start", "value": "", "type": "query", "description": "Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset." }, { "name": "unit_height", "value": "", "type": "query" }, { "name": "unit_width", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG." }, { "info": { "name": "dcim_rear_port_templates_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rear-port-templates/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "front_port_id", "value": "", "type": "query", "description": "Front port (ID)" }, { "name": "front_port_id__n", "value": "", "type": "query", "description": "Front port (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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": "module_type_id", "value": "", "type": "query", "description": "Module type (ID)" }, { "name": "module_type_id__n", "value": "", "type": "query", "description": "Module type (ID)" }, { "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": "positions", "value": "", "type": "query" }, { "name": "positions__empty", "value": "", "type": "query" }, { "name": "positions__gt", "value": "", "type": "query" }, { "name": "positions__gte", "value": "", "type": "query" }, { "name": "positions__lt", "value": "", "type": "query" }, { "name": "positions__lte", "value": "", "type": "query" }, { "name": "positions__n", "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": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of rear port template objects." }, { "info": { "name": "dcim_rear_port_templates_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/rear-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rear port template objects." }, { "info": { "name": "dcim_rear_port_templates_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rear-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rear port template objects." }, { "info": { "name": "dcim_rear_port_templates_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rear-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rear port template objects." }, { "info": { "name": "dcim_rear_port_templates_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rear-port-templates/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rear port template objects." }, { "info": { "name": "dcim_rear_port_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rear-port-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 rear port 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 rear port template object." }, { "info": { "name": "dcim_rear_port_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rear-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rear port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rear port template object." }, { "info": { "name": "dcim_rear_port_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rear-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rear port template." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rear port template object." }, { "info": { "name": "dcim_rear_port_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rear-port-templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rear port template." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rear port template object." }, { "info": { "name": "dcim_rear_ports_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rear-ports/", "params": [ { "name": "brief", "value": "", "type": "query", "description": "Return only brief fields for each object." }, { "name": "cable_connector", "value": "", "type": "query" }, { "name": "cable_connector__empty", "value": "", "type": "query" }, { "name": "cable_connector__gt", "value": "", "type": "query" }, { "name": "cable_connector__gte", "value": "", "type": "query" }, { "name": "cable_connector__lt", "value": "", "type": "query" }, { "name": "cable_connector__lte", "value": "", "type": "query" }, { "name": "cable_connector__n", "value": "", "type": "query" }, { "name": "cable_end", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__empty", "value": "", "type": "query" }, { "name": "cable_end__ic", "value": "", "type": "query" }, { "name": "cable_end__ie", "value": "", "type": "query" }, { "name": "cable_end__iew", "value": "", "type": "query" }, { "name": "cable_end__iregex", "value": "", "type": "query" }, { "name": "cable_end__isw", "value": "", "type": "query" }, { "name": "cable_end__n", "value": "", "type": "query", "description": "* `A` - A\n* `B` - B" }, { "name": "cable_end__nic", "value": "", "type": "query" }, { "name": "cable_end__nie", "value": "", "type": "query" }, { "name": "cable_end__niew", "value": "", "type": "query" }, { "name": "cable_end__nisw", "value": "", "type": "query" }, { "name": "cable_end__regex", "value": "", "type": "query" }, { "name": "cable_id", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cable_id__n", "value": "", "type": "query", "description": "Cable (ID)" }, { "name": "cabled", "value": "", "type": "query" }, { "name": "color", "value": "", "type": "query" }, { "name": "color__empty", "value": "", "type": "query" }, { "name": "color__ic", "value": "", "type": "query" }, { "name": "color__ie", "value": "", "type": "query" }, { "name": "color__iew", "value": "", "type": "query" }, { "name": "color__iregex", "value": "", "type": "query" }, { "name": "color__isw", "value": "", "type": "query" }, { "name": "color__n", "value": "", "type": "query" }, { "name": "color__nic", "value": "", "type": "query" }, { "name": "color__nie", "value": "", "type": "query" }, { "name": "color__niew", "value": "", "type": "query" }, { "name": "color__nisw", "value": "", "type": "query" }, { "name": "color__regex", "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": "device", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device__n", "value": "", "type": "query", "description": "Device (name)" }, { "name": "device_id", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "Device (ID)" }, { "name": "device_role", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role__n", "value": "", "type": "query", "description": "Device role (slug)" }, { "name": "device_role_id", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_role_id__n", "value": "", "type": "query", "description": "Device role (ID)" }, { "name": "device_status", "value": "", "type": "query" }, { "name": "device_status__empty", "value": "", "type": "query" }, { "name": "device_status__ic", "value": "", "type": "query" }, { "name": "device_status__ie", "value": "", "type": "query" }, { "name": "device_status__iew", "value": "", "type": "query" }, { "name": "device_status__iregex", "value": "", "type": "query" }, { "name": "device_status__isw", "value": "", "type": "query" }, { "name": "device_status__n", "value": "", "type": "query" }, { "name": "device_status__nic", "value": "", "type": "query" }, { "name": "device_status__nie", "value": "", "type": "query" }, { "name": "device_status__niew", "value": "", "type": "query" }, { "name": "device_status__nisw", "value": "", "type": "query" }, { "name": "device_status__regex", "value": "", "type": "query" }, { "name": "device_type", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type__n", "value": "", "type": "query", "description": "Device type (model)" }, { "name": "device_type_id", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "device_type_id__n", "value": "", "type": "query", "description": "Device type (ID)" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "front_port_id", "value": "", "type": "query", "description": "Front port (ID)" }, { "name": "front_port_id__n", "value": "", "type": "query", "description": "Front port (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": "label", "value": "", "type": "query" }, { "name": "label__empty", "value": "", "type": "query" }, { "name": "label__ic", "value": "", "type": "query" }, { "name": "label__ie", "value": "", "type": "query" }, { "name": "label__iew", "value": "", "type": "query" }, { "name": "label__iregex", "value": "", "type": "query" }, { "name": "label__isw", "value": "", "type": "query" }, { "name": "label__n", "value": "", "type": "query" }, { "name": "label__nic", "value": "", "type": "query" }, { "name": "label__nie", "value": "", "type": "query" }, { "name": "label__niew", "value": "", "type": "query" }, { "name": "label__nisw", "value": "", "type": "query" }, { "name": "label__regex", "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", "description": "Location (slug)" }, { "name": "location__n", "value": "", "type": "query", "description": "Location (slug)" }, { "name": "location_id", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "location_id__n", "value": "", "type": "query", "description": "Location (ID)" }, { "name": "mark_connected", "value": "", "type": "query" }, { "name": "modified_by_request", "value": "", "type": "query" }, { "name": "module_id", "value": "", "type": "query", "description": "Module (ID)" }, { "name": "module_id__n", "value": "", "type": "query", "description": "Module (ID)" }, { "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": "occupied", "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": "positions", "value": "", "type": "query" }, { "name": "positions__empty", "value": "", "type": "query" }, { "name": "positions__gt", "value": "", "type": "query" }, { "name": "positions__gte", "value": "", "type": "query" }, { "name": "positions__lt", "value": "", "type": "query" }, { "name": "positions__lte", "value": "", "type": "query" }, { "name": "positions__n", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query", "description": "Search" }, { "name": "rack", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack__n", "value": "", "type": "query", "description": "Rack (name)" }, { "name": "rack_id", "value": "", "type": "query", "description": "Rack (ID)" }, { "name": "rack_id__n", "value": "", "type": "query", "description": "Rack (ID)" }, { "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": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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_id", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "tenant_id__n", "value": "", "type": "query", "description": "Tenant (ID)" }, { "name": "type", "value": "", "type": "query" }, { "name": "type__empty", "value": "", "type": "query" }, { "name": "type__ic", "value": "", "type": "query" }, { "name": "type__ie", "value": "", "type": "query" }, { "name": "type__iew", "value": "", "type": "query" }, { "name": "type__iregex", "value": "", "type": "query" }, { "name": "type__isw", "value": "", "type": "query" }, { "name": "type__n", "value": "", "type": "query" }, { "name": "type__nic", "value": "", "type": "query" }, { "name": "type__nie", "value": "", "type": "query" }, { "name": "type__niew", "value": "", "type": "query" }, { "name": "type__nisw", "value": "", "type": "query" }, { "name": "type__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" }, { "name": "virtual_chassis", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis__n", "value": "", "type": "query", "description": "Virtual Chassis" }, { "name": "virtual_chassis_id", "value": "", "type": "query", "description": "Virtual Chassis (ID)" }, { "name": "virtual_chassis_id__n", "value": "", "type": "query", "description": "Virtual Chassis (ID)" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of rear port objects." }, { "info": { "name": "dcim_rear_ports_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/rear-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of rear port objects." }, { "info": { "name": "dcim_rear_ports_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rear-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of rear port objects." }, { "info": { "name": "dcim_rear_ports_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rear-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of rear port objects." }, { "info": { "name": "dcim_rear_ports_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rear-ports/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of rear port objects." }, { "info": { "name": "dcim_rear_ports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rear-ports/: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 rear port." }, { "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 rear port object." }, { "info": { "name": "dcim_rear_ports_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/rear-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rear port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a rear port object." }, { "info": { "name": "dcim_rear_ports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/rear-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rear port." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a rear port object." }, { "info": { "name": "dcim_rear_ports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/rear-ports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this rear port." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a rear port object." }, { "info": { "name": "dcim_rear_ports_paths_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/rear-ports/:id/paths/", "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 rear port." }, { "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": "Return all CablePaths which traverse a given pass-through port." }, { "info": { "name": "dcim_regions_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/regions/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "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": "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": "parent", "value": "", "type": "query", "description": "Parent region (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Parent region (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Parent region (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent region (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 region objects." }, { "info": { "name": "dcim_regions_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/regions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of region objects." }, { "info": { "name": "dcim_regions_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/regions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of region objects." }, { "info": { "name": "dcim_regions_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/regions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of region objects." }, { "info": { "name": "dcim_regions_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/regions/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of region objects." }, { "info": { "name": "dcim_regions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/regions/: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 region." }, { "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 region object." }, { "info": { "name": "dcim_regions_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/regions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this region." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a region object." }, { "info": { "name": "dcim_regions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/regions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this region." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a region object." }, { "info": { "name": "dcim_regions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/regions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this region." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a region object." }, { "info": { "name": "dcim_site_groups_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/site-groups/", "params": [ { "name": "ancestor", "value": "", "type": "query" }, { "name": "ancestor__n", "value": "", "type": "query" }, { "name": "ancestor_id", "value": "", "type": "query" }, { "name": "ancestor_id__n", "value": "", "type": "query" }, { "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": "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": "parent", "value": "", "type": "query", "description": "Parent site group (slug)" }, { "name": "parent__n", "value": "", "type": "query", "description": "Parent site group (slug)" }, { "name": "parent_id", "value": "", "type": "query", "description": "Parent site group (ID)" }, { "name": "parent_id__n", "value": "", "type": "query", "description": "Parent site group (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 site group objects." }, { "info": { "name": "dcim_site_groups_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/site-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of site group objects." }, { "info": { "name": "dcim_site_groups_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/site-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of site group objects." }, { "info": { "name": "dcim_site_groups_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/site-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of site group objects." }, { "info": { "name": "dcim_site_groups_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/site-groups/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of site group objects." }, { "info": { "name": "dcim_site_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/site-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 site 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 site group object." }, { "info": { "name": "dcim_site_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/site-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this site group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a site group object." }, { "info": { "name": "dcim_site_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/site-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this site group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a site group object." }, { "info": { "name": "dcim_site_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/site-groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this site group." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a site group object." }, { "info": { "name": "dcim_sites_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/sites/", "params": [ { "name": "asn", "value": "", "type": "query", "description": "AS (ID)" }, { "name": "asn__n", "value": "", "type": "query", "description": "AS (ID)" }, { "name": "asn_id", "value": "", "type": "query", "description": "AS (ID)" }, { "name": "asn_id__n", "value": "", "type": "query", "description": "AS (ID)" }, { "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": "facility", "value": "", "type": "query" }, { "name": "facility__empty", "value": "", "type": "query" }, { "name": "facility__ic", "value": "", "type": "query" }, { "name": "facility__ie", "value": "", "type": "query" }, { "name": "facility__iew", "value": "", "type": "query" }, { "name": "facility__iregex", "value": "", "type": "query" }, { "name": "facility__isw", "value": "", "type": "query" }, { "name": "facility__n", "value": "", "type": "query" }, { "name": "facility__nic", "value": "", "type": "query" }, { "name": "facility__nie", "value": "", "type": "query" }, { "name": "facility__niew", "value": "", "type": "query" }, { "name": "facility__nisw", "value": "", "type": "query" }, { "name": "facility__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" }, { "name": "group__n", "value": "", "type": "query" }, { "name": "group_id", "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": "latitude", "value": "", "type": "query" }, { "name": "latitude__empty", "value": "", "type": "query" }, { "name": "latitude__gt", "value": "", "type": "query" }, { "name": "latitude__gte", "value": "", "type": "query" }, { "name": "latitude__lt", "value": "", "type": "query" }, { "name": "latitude__lte", "value": "", "type": "query" }, { "name": "latitude__n", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "longitude", "value": "", "type": "query" }, { "name": "longitude__empty", "value": "", "type": "query" }, { "name": "longitude__gt", "value": "", "type": "query" }, { "name": "longitude__gte", "value": "", "type": "query" }, { "name": "longitude__lt", "value": "", "type": "query" }, { "name": "longitude__lte", "value": "", "type": "query" }, { "name": "longitude__n", "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": "region", "value": "", "type": "query" }, { "name": "region__n", "value": "", "type": "query" }, { "name": "region_id", "value": "", "type": "query" }, { "name": "region_id__n", "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": "status", "value": "", "type": "query" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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": "time_zone", "value": "", "type": "query" }, { "name": "time_zone__ic", "value": "", "type": "query" }, { "name": "time_zone__ie", "value": "", "type": "query" }, { "name": "time_zone__iew", "value": "", "type": "query" }, { "name": "time_zone__iregex", "value": "", "type": "query" }, { "name": "time_zone__isw", "value": "", "type": "query" }, { "name": "time_zone__n", "value": "", "type": "query" }, { "name": "time_zone__nic", "value": "", "type": "query" }, { "name": "time_zone__nie", "value": "", "type": "query" }, { "name": "time_zone__niew", "value": "", "type": "query" }, { "name": "time_zone__nisw", "value": "", "type": "query" }, { "name": "time_zone__regex", "value": "", "type": "query" }, { "name": "updated_by_request", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Get a list of site objects." }, { "info": { "name": "dcim_sites_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/sites/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of site objects." }, { "info": { "name": "dcim_sites_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/sites/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of site objects." }, { "info": { "name": "dcim_sites_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/sites/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of site objects." }, { "info": { "name": "dcim_sites_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/sites/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of site objects." }, { "info": { "name": "dcim_sites_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/sites/: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 site." }, { "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 site object." }, { "info": { "name": "dcim_sites_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/sites/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this site." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a site object." }, { "info": { "name": "dcim_sites_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/sites/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this site." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a site object." }, { "info": { "name": "dcim_sites_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/sites/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this site." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a site object." }, { "info": { "name": "dcim_virtual_chassis_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/virtual-chassis/", "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": "domain", "value": "", "type": "query" }, { "name": "domain__empty", "value": "", "type": "query" }, { "name": "domain__ic", "value": "", "type": "query" }, { "name": "domain__ie", "value": "", "type": "query" }, { "name": "domain__iew", "value": "", "type": "query" }, { "name": "domain__iregex", "value": "", "type": "query" }, { "name": "domain__isw", "value": "", "type": "query" }, { "name": "domain__n", "value": "", "type": "query" }, { "name": "domain__nic", "value": "", "type": "query" }, { "name": "domain__nie", "value": "", "type": "query" }, { "name": "domain__niew", "value": "", "type": "query" }, { "name": "domain__nisw", "value": "", "type": "query" }, { "name": "domain__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": "master", "value": "", "type": "query", "description": "Master (name)" }, { "name": "master__n", "value": "", "type": "query", "description": "Master (name)" }, { "name": "master_id", "value": "", "type": "query", "description": "Master (ID)" }, { "name": "master_id__n", "value": "", "type": "query", "description": "Master (ID)" }, { "name": "member_count", "value": "", "type": "query" }, { "name": "member_count__empty", "value": "", "type": "query" }, { "name": "member_count__gt", "value": "", "type": "query" }, { "name": "member_count__gte", "value": "", "type": "query" }, { "name": "member_count__lt", "value": "", "type": "query" }, { "name": "member_count__lte", "value": "", "type": "query" }, { "name": "member_count__n", "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": "region", "value": "", "type": "query" }, { "name": "region__n", "value": "", "type": "query" }, { "name": "region_id", "value": "", "type": "query" }, { "name": "region_id__n", "value": "", "type": "query" }, { "name": "site", "value": "", "type": "query", "description": "Site name (slug)" }, { "name": "site__n", "value": "", "type": "query", "description": "Site name (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_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 virtual chassis objects." }, { "info": { "name": "dcim_virtual_chassis_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/virtual-chassis/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of virtual chassis objects." }, { "info": { "name": "dcim_virtual_chassis_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/virtual-chassis/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of virtual chassis objects." }, { "info": { "name": "dcim_virtual_chassis_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/virtual-chassis/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of virtual chassis objects." }, { "info": { "name": "dcim_virtual_chassis_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/virtual-chassis/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of virtual chassis objects." }, { "info": { "name": "dcim_virtual_chassis_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/virtual-chassis/: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 virtual chassis." }, { "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 virtual chassis object." }, { "info": { "name": "dcim_virtual_chassis_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/virtual-chassis/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this virtual chassis." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a virtual chassis object." }, { "info": { "name": "dcim_virtual_chassis_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/virtual-chassis/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this virtual chassis." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a virtual chassis object." }, { "info": { "name": "dcim_virtual_chassis_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/virtual-chassis/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this virtual chassis." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a virtual chassis object." }, { "info": { "name": "dcim_virtual_device_contexts_list", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/virtual-device-contexts/", "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": "device", "value": "", "type": "query", "description": "Device model" }, { "name": "device__n", "value": "", "type": "query", "description": "Device model" }, { "name": "device_id", "value": "", "type": "query", "description": "VDC (ID)" }, { "name": "device_id__n", "value": "", "type": "query", "description": "VDC (ID)" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields to include in the response. Example: `fields=id,name`." }, { "name": "has_primary_ip", "value": "", "type": "query", "description": "Has a primary IP" }, { "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": "identifier", "value": "", "type": "query" }, { "name": "identifier__empty", "value": "", "type": "query" }, { "name": "identifier__gt", "value": "", "type": "query" }, { "name": "identifier__gte", "value": "", "type": "query" }, { "name": "identifier__lt", "value": "", "type": "query" }, { "name": "identifier__lte", "value": "", "type": "query" }, { "name": "identifier__n", "value": "", "type": "query" }, { "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": "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": "primary_ip4", "value": "", "type": "query", "description": "Primary IPv4 (address)" }, { "name": "primary_ip4__n", "value": "", "type": "query", "description": "Primary IPv4 (address)" }, { "name": "primary_ip4_id", "value": "", "type": "query", "description": "Primary IPv4 (ID)" }, { "name": "primary_ip4_id__n", "value": "", "type": "query", "description": "Primary IPv4 (ID)" }, { "name": "primary_ip6", "value": "", "type": "query", "description": "Primary IPv6 (address)" }, { "name": "primary_ip6__n", "value": "", "type": "query", "description": "Primary IPv6 (address)" }, { "name": "primary_ip6_id", "value": "", "type": "query", "description": "Primary IPv6 (ID)" }, { "name": "primary_ip6_id__n", "value": "", "type": "query", "description": "Primary IPv6 (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": "status", "value": "", "type": "query" }, { "name": "status__empty", "value": "", "type": "query" }, { "name": "status__ic", "value": "", "type": "query" }, { "name": "status__ie", "value": "", "type": "query" }, { "name": "status__iew", "value": "", "type": "query" }, { "name": "status__iregex", "value": "", "type": "query" }, { "name": "status__isw", "value": "", "type": "query" }, { "name": "status__n", "value": "", "type": "query" }, { "name": "status__nic", "value": "", "type": "query" }, { "name": "status__nie", "value": "", "type": "query" }, { "name": "status__niew", "value": "", "type": "query" }, { "name": "status__nisw", "value": "", "type": "query" }, { "name": "status__regex", "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 virtual device context objects." }, { "info": { "name": "dcim_virtual_device_contexts_create", "type": "http" }, "http": { "method": "POST", "url": "/api/dcim/virtual-device-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Post a list of virtual device context objects." }, { "info": { "name": "dcim_virtual_device_contexts_bulk_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/virtual-device-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a list of virtual device context objects." }, { "info": { "name": "dcim_virtual_device_contexts_bulk_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/virtual-device-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a list of virtual device context objects." }, { "info": { "name": "dcim_virtual_device_contexts_bulk_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/virtual-device-contexts/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a list of virtual device context objects." }, { "info": { "name": "dcim_virtual_device_contexts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "/api/dcim/virtual-device-contexts/: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 virtual device context." }, { "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 virtual device context object." }, { "info": { "name": "dcim_virtual_device_contexts_update", "type": "http" }, "http": { "method": "PUT", "url": "/api/dcim/virtual-device-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this virtual device context." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Put a virtual device context object." }, { "info": { "name": "dcim_virtual_device_contexts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "/api/dcim/virtual-device-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this virtual device context." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Patch a virtual device context object." }, { "info": { "name": "dcim_virtual_device_contexts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "/api/dcim/virtual-device-contexts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this virtual device context." } ], "auth": { "type": "apikey", "key": "sessionid", "value": "{{sessionid}}", "placement": "query" } }, "docs": "Delete a virtual device context object." } ] } ], "bundled": true }