components: schemas: AccessGrant: description: API serializer for interacting with AccessGrant objects. properties: command: description: Enter * to grant access to all commands maxLength: 64 type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string grant_type: $ref: '#/components/schemas/GrantTypeEnum' id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Organization name, channel name, or user name maxLength: 255 type: string subcommand: description: Enter * to grant access to all subcommands of the given command maxLength: 64 type: string url: format: uri readOnly: true type: string value: description: Corresponding ID value to grant access to.
Enter * to grant access to all organizations, channels, or users maxLength: 255 type: string required: - command - created - display - grant_type - id - last_updated - name - subcommand - url - value type: object AccessGrantRequest: description: API serializer for interacting with AccessGrant objects. properties: command: description: Enter * to grant access to all commands maxLength: 64 minLength: 1 type: string grant_type: $ref: '#/components/schemas/GrantTypeEnum' name: description: Organization name, channel name, or user name maxLength: 255 minLength: 1 type: string subcommand: description: Enter * to grant access to all subcommands of the given command maxLength: 64 minLength: 1 type: string value: description: Corresponding ID value to grant access to.
Enter * to grant access to all organizations, channels, or users maxLength: 255 minLength: 1 type: string required: - command - grant_type - name - subcommand - value type: object AccessTypeEnum: enum: - Generic - Console - gNMI - HTTP(S) - NETCONF - REST - RESTCONF - SNMP - SSH type: string ActionEnum: enum: - allow - deny - drop - remark type: string AddressFamily: description: REST API serializer for AddressFamily records. properties: afi_safi: $ref: '#/components/schemas/AfiSafiEnum' created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string export_policy: maxLength: 100 type: string id: format: uuid readOnly: true type: string import_policy: maxLength: 100 type: string last_updated: format: date-time nullable: true readOnly: true type: string routing_instance: $ref: '#/components/schemas/NestedRoutingInstance' url: format: uri readOnly: true type: string vrf: allOf: - $ref: '#/components/schemas/NestedVRF' nullable: true required: - afi_safi - created - display - id - last_updated - routing_instance - url type: object AddressObject: description: AddressObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object AddressObjectGroup: description: AddressObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object AfiSafiEnum: enum: - ipv4_unicast - ipv4_multicast - ipv4_flowspec - ipv6_unicast - ipv6_multicast - ipv6_flowspec - vpnv4_unicast - vpnv4_multicast - vpnv6_unicast - vpnv6_multicast - l2_evpn - l2_vpls type: string Aggregate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object date_added: format: date nullable: true type: string description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string family: properties: label: enum: - IPv4 - IPv6 type: string value: enum: - 4 - 6 type: integer readOnly: true type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string notes_url: format: uri readOnly: true type: string prefix: type: string rir: $ref: '#/components/schemas/NestedRIR' tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string required: - created - display - family - id - last_updated - notes_url - prefix - rir - url type: object AutonomousSystem: description: REST API serializer for AutonomousSystem records. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string provider: allOf: - $ref: '#/components/schemas/NestedProvider' nullable: true status: properties: label: enum: - Active - Available - Planned type: string value: enum: - active - available - planned type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - asn - created - display - id - last_updated - status - url type: object AvailableIP: description: Representation of an IP address which does not exist in the database. properties: address: readOnly: true type: string family: readOnly: true type: integer vrf: allOf: - $ref: '#/components/schemas/NestedVRF' readOnly: true required: - address - family - vrf type: object AvailablePrefix: description: Representation of a prefix which does not exist in the database. properties: family: readOnly: true type: integer prefix: readOnly: true type: string vrf: allOf: - $ref: '#/components/schemas/NestedVRF' readOnly: true required: - family - prefix - vrf type: object BGPRoutingInstance: description: REST API serializer for Peering records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystem' nullable: true created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string endpoints: items: $ref: '#/components/schemas/NestedPeerEndpoint' type: array id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string router_id: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true url: format: uri readOnly: true type: string required: - created - device - display - id - last_updated - url type: object BlankEnum: enum: - '' BulkOperationIntegerIDRequest: description: As BulkOperationSerializer, but for models such as users.Group that have an integer ID field. properties: id: type: integer required: - id type: object BulkOperationRequest: description: Representation of bulk-DELETE request for most models; also used to validate required ID field for bulk-PATCH/PUT. properties: id: format: uuid type: string required: - id type: object BulkWritableAccessGrantRequest: description: API serializer for interacting with AccessGrant objects. properties: command: description: Enter * to grant access to all commands maxLength: 64 minLength: 1 type: string grant_type: $ref: '#/components/schemas/GrantTypeEnum' id: format: uuid type: string name: description: Organization name, channel name, or user name maxLength: 255 minLength: 1 type: string subcommand: description: Enter * to grant access to all subcommands of the given command maxLength: 64 minLength: 1 type: string value: description: Corresponding ID value to grant access to.
Enter * to grant access to all organizations, channels, or users maxLength: 255 minLength: 1 type: string required: - command - grant_type - id - name - subcommand - value type: object BulkWritableAddressFamilyRequest: description: REST API serializer for AddressFamily records. properties: afi_safi: $ref: '#/components/schemas/AfiSafiEnum' custom_fields: additionalProperties: {} type: object export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string vrf: allOf: - $ref: '#/components/schemas/NestedVRFRequest' nullable: true required: - afi_safi - id type: object BulkWritableAddressObjectGroupRequest: description: AddressObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableAddressObjectRequest: description: AddressObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' id: format: uuid type: string ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableAggregateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object date_added: format: date nullable: true type: string description: maxLength: 200 type: string id: format: uuid type: string prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object rir: $ref: '#/components/schemas/NestedRIRRequest' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id - prefix - rir type: object BulkWritableAutonomousSystemRequest: description: REST API serializer for AutonomousSystem records. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderRequest' nullable: true status: $ref: '#/components/schemas/Status2a0Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - asn - id - status type: object BulkWritableBGPRoutingInstanceRequest: description: REST API serializer for Peering records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string router_id: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true required: - device - id type: object BulkWritableCVELCMRequest: description: REST API serializer for CVELCM records. properties: comments: type: string custom_fields: additionalProperties: {} type: object cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string fix: maxLength: 255 nullable: true type: string id: format: uuid type: string link: format: uri maxLength: 200 minLength: 1 type: string name: maxLength: 16 minLength: 1 type: string published_date: format: date type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object severity: $ref: '#/components/schemas/SeverityEnum' status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - link - name - published_date type: object BulkWritableCableRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string label: maxLength: 100 type: string length: maximum: 32767 minimum: 0 nullable: true type: integer length_unit: $ref: '#/components/schemas/LengthUnitEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CableStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array termination_a_id: format: uuid type: string termination_a_type: type: string termination_b_id: format: uuid type: string termination_b_type: type: string type: oneOf: - $ref: '#/components/schemas/CableTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - id - status - termination_a_id - termination_a_type - termination_b_id - termination_b_type type: object BulkWritableCapircaPolicyRequest: description: CapircaPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object cfg: nullable: true type: string custom_fields: additionalProperties: {} type: object device: format: uuid nullable: true type: string id: format: uuid type: string net: nullable: true type: string pol: nullable: true type: string svc: nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object BulkWritableCircuitMaintenanceCircuitImpactRequest: description: Serializer for API. properties: circuit: format: uuid type: string id: format: uuid type: string impact: nullable: true oneOf: - $ref: '#/components/schemas/ImpactEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' maintenance: format: uuid type: string required: - circuit - id - maintenance type: object BulkWritableCircuitMaintenanceRequest: description: Serializer for API. properties: ack: nullable: true type: boolean description: nullable: true type: string end_time: format: date-time type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string start_time: format: date-time type: string status: nullable: true oneOf: - $ref: '#/components/schemas/StatusD95Enum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - end_time - id - start_time type: object BulkWritableCircuitRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cid: maxLength: 100 minLength: 1 title: Circuit ID type: string comments: type: string commit_rate: maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string install_date: format: date nullable: true title: Date installed type: string provider: $ref: '#/components/schemas/NestedProviderRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CircuitStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true type: $ref: '#/components/schemas/NestedCircuitTypeRequest' required: - cid - id - provider - status - type type: object BulkWritableCircuitTerminationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: circuit: $ref: '#/components/schemas/NestedCircuitRequest' custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer pp_info: maxLength: 100 title: Patch panel/port(s) type: string provider_network: allOf: - $ref: '#/components/schemas/NestedProviderNetworkRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true term_side: allOf: - $ref: '#/components/schemas/TermSideEnum' title: Termination upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer xconnect_id: maxLength: 50 title: Cross-connect ID type: string required: - circuit - id - term_side type: object BulkWritableCircuitTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableClusterGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableClusterRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object group: allOf: - $ref: '#/components/schemas/NestedClusterGroupRequest' nullable: true id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true type: $ref: '#/components/schemas/NestedClusterTypeRequest' required: - id - name - type type: object BulkWritableClusterTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableCommandTokenRequest: description: API serializer for interacting with CommandToken objects. properties: comment: description: 'Optional: Enter description of token' maxLength: 255 type: string id: format: uuid type: string platform: $ref: '#/components/schemas/PlatformEnum' token: description: Token given by chat platform for signing or command validation maxLength: 255 minLength: 1 type: string required: - id - platform - token type: object BulkWritableComplianceFeatureRequest: description: Serializer for ComplianceFeature object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - slug type: object BulkWritableComplianceRuleRequest: description: Serializer for ComplianceRule object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object config_ordered: description: Whether or not the configuration order matters, such as in ACLs. title: Configured Ordered type: boolean config_type: allOf: - $ref: '#/components/schemas/ConfigTypeEnum' description: Whether the config is in cli or json/structured format. custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string feature: format: uuid type: string id: format: uuid type: string match_config: description: The config to match that is matched based on the parent most configuration. e.g. `router bgp` or `ntp`. nullable: true title: Config to Match type: string platform: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - config_ordered - feature - id - platform type: object BulkWritableComputedFieldRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string description: maxLength: 200 type: string fallback_value: description: Fallback value (if any) to be output for the field in the case of a template rendering error. maxLength: 500 type: string id: format: uuid type: string label: description: Name of the field as displayed to users maxLength: 100 minLength: 1 type: string slug: description: Internal field name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string template: description: Jinja2 template code for field value maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer required: - content_type - id - label - template type: object BulkWritableConfigComplianceRequest: description: Serializer for ConfigCompliance object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object actual: additionalProperties: {} description: Actual Configuration for feature type: object compliance: nullable: true type: boolean compliance_int: maximum: 2147483647 minimum: -2147483648 nullable: true type: integer custom_fields: additionalProperties: {} type: object device: description: The device format: uuid type: string extra: additionalProperties: {} description: Configuration that should not be on the device. type: object id: format: uuid type: string intended: additionalProperties: {} description: Intended Configuration for feature type: object missing: additionalProperties: {} description: Configuration that should be on the device. type: object ordered: type: boolean rule: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - id - rule type: object BulkWritableConfigContextRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: cluster_groups: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array clusters: items: properties: name: maxLength: 100 minLength: 1 type: string required: - name type: object type: array data: additionalProperties: {} type: object description: maxLength: 200 type: string device_types: items: properties: model: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - model - slug type: object type: array id: format: uuid type: string is_active: type: boolean locations: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string platforms: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array regions: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array roles: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchemaRequest' nullable: true sites: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array tags: items: type: string type: array tenant_groups: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array tenants: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array weight: maximum: 32767 minimum: 0 type: integer required: - data - id - name type: object BulkWritableConfigContextSchemaRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object data_schema: additionalProperties: {} description: A JSON Schema document which is used to validate a config context object. type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 200 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - data_schema - id - name type: object BulkWritableConfigRemoveRequest: description: Serializer for ConfigRemove object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern used to remove a line from the backup configuration. maxLength: 200 minLength: 1 title: Regex Pattern type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - platform - regex type: object BulkWritableConfigReplaceRequest: description: Serializer for ConfigReplace object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern that will be found and replaced with 'replaced text'. maxLength: 200 minLength: 1 title: Regex Pattern to Substitute type: string replace: description: Text that will be inserted in place of Regex pattern match. maxLength: 200 minLength: 1 title: Replaced Text type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - platform - regex - replace type: object BulkWritableConsolePortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - device - id - name type: object BulkWritableConsolePortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - device_type - id - name type: object BulkWritableConsoleServerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - device - id - name type: object BulkWritableConsoleServerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - device_type - id - name type: object BulkWritableContactLCMRequest: description: API serializer. properties: address: maxLength: 200 type: string comments: type: string contract: allOf: - $ref: '#/components/schemas/NestedContractLCMRequest' description: Associated Contract custom_fields: additionalProperties: {} type: object email: format: email maxLength: 254 title: Contact E-mail type: string id: format: uuid type: string name: maxLength: 80 minLength: 1 nullable: true type: string phone: maxLength: 20 type: string priority: maximum: 2147483647 minimum: 0 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - contract - id - name type: object BulkWritableContractLCMRequest: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string custom_fields: additionalProperties: {} type: object end: format: date nullable: true title: Contract End Date type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderLCMRequest' description: Vendor relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - provider type: object BulkWritableCustomFieldChoiceRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: field: $ref: '#/components/schemas/NestedCustomFieldRequest' id: format: uuid type: string value: maxLength: 100 minLength: 1 type: string weight: description: Higher weights appear later in the list maximum: 32767 minimum: 0 type: integer required: - field - id - value type: object BulkWritableCustomLinkRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: button_class: allOf: - $ref: '#/components/schemas/ButtonClassEnum' description: The class of the first link in a group will be used for the dropdown button content_type: type: string group_name: description: Links with the same group will appear as a dropdown menu maxLength: 50 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string new_window: description: Force link to open in a new window type: boolean target_url: description: Jinja2 template code for link URL. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. maxLength: 500 minLength: 1 title: URL type: string text: description: Jinja2 template code for link text. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. Links which render as empty text will not be displayed. maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer required: - content_type - id - name - new_window - target_url - text type: object BulkWritableDeviceBayRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string installed_device: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - id - name type: object BulkWritableDeviceBayTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object required: - device_type - id - name type: object BulkWritableDeviceRedundancyGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string failover_strategy: $ref: '#/components/schemas/FailoverStrategyEnum' id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - failover_strategy - id - name - status type: object BulkWritableDeviceRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string vm_role: description: Virtual machines may be assigned to this role type: boolean required: - id - name type: object BulkWritableDeviceTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object front_image: format: binary type: string id: format: uuid type: string is_full_depth: description: Device consumes both front and rear rack faces type: boolean manufacturer: $ref: '#/components/schemas/NestedManufacturerRequest' model: maxLength: 100 minLength: 1 type: string part_number: description: Discrete part number (optional) maxLength: 50 type: string rear_image: format: binary type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string subdevice_role: $ref: '#/components/schemas/SubdeviceRoleEnum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array u_height: maximum: 32767 minimum: 0 title: Height (U) type: integer required: - id - manufacturer - model type: object BulkWritableDeviceWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: allOf: - $ref: '#/components/schemas/NestedClusterRequest' nullable: true comments: type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: allOf: - $ref: '#/components/schemas/NestedDeviceRedundancyGroupRequest' nullable: true device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: $ref: '#/components/schemas/NestedDeviceRoleRequest' device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' face: $ref: '#/components/schemas/FaceEnum' id: format: uuid type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchemaRequest' nullable: true location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 64 nullable: true type: string platform: allOf: - $ref: '#/components/schemas/NestedPlatformRequest' nullable: true position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true rack: allOf: - $ref: '#/components/schemas/NestedRackRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroupRequest' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSiteRequest' status: $ref: '#/components/schemas/DeviceStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: allOf: - $ref: '#/components/schemas/NestedVirtualChassisRequest' nullable: true required: - device_role - device_type - id - site - status type: object BulkWritableDynamicGroupMembershipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: group: $ref: '#/components/schemas/NestedDynamicGroupRequest' id: format: uuid type: string operator: $ref: '#/components/schemas/OperatorEnum' parent_group: $ref: '#/components/schemas/NestedDynamicGroupRequest' weight: maximum: 32767 minimum: 0 type: integer required: - group - id - operator - parent_group - weight type: object BulkWritableDynamicGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_type: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string filter: additionalProperties: {} description: A JSON-encoded dictionary of filter parameters for group membership type: object id: format: uuid type: string name: description: Dynamic Group name maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_type - filter - id - name type: object BulkWritableExportTemplateRequest: description: Extend ValidatedModelSerializer with a `relationships` field. properties: content_type: type: string description: maxLength: 200 type: string file_extension: description: Extension to append to the rendered filename maxLength: 15 type: string id: format: uuid type: string mime_type: description: Defaults to text/plain maxLength: 50 type: string name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object template_code: description: The list of objects being exported is passed as a context variable named queryset. minLength: 1 type: string required: - content_type - id - name - template_code type: object BulkWritableFQDNRequest: description: FQDN Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string ip_addresses: items: properties: address: minLength: 1 type: string required: - address type: object type: array name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableFrontPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: $ref: '#/components/schemas/FrontPortRearPortRequest' rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' required: - device - id - name - rear_port - type type: object BulkWritableFrontPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: $ref: '#/components/schemas/NestedRearPortTemplateRequest' rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' required: - device_type - id - name - rear_port - type type: object BulkWritableGitRepositoryRequest: description: Git repositories defined as a data source. properties: branch: maxLength: 64 minLength: 1 type: string current_head: description: Commit hash of the most recent fetch from the selected branch. Used for syncing between workers. maxLength: 48 type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string provided_contents: items: oneOf: - $ref: '#/components/schemas/ProvidedContentsEnum' - $ref: '#/components/schemas/BlankEnum' type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remote_url: description: Only HTTP and HTTPS URLs are presently supported format: uri maxLength: 255 minLength: 1 type: string secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroupRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string token: minLength: 1 type: string writeOnly: true username: maxLength: 64 type: string required: - id - name - remote_url type: object BulkWritableGoldenConfigRequest: description: Serializer for GoldenConfig object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_config: description: Full backup config for device. type: string backup_last_attempt_date: format: date-time nullable: true type: string backup_last_success_date: format: date-time nullable: true type: string compliance_config: description: Full config diff for device. type: string compliance_last_attempt_date: format: date-time nullable: true type: string compliance_last_success_date: format: date-time nullable: true type: string custom_fields: additionalProperties: {} type: object device: description: device format: uuid type: string id: format: uuid type: string intended_config: description: Intended config for the device. type: string intended_last_attempt_date: format: date-time nullable: true type: string intended_last_success_date: format: date-time nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - id type: object BulkWritableGoldenConfigSettingRequest: description: Serializer for GoldenConfigSetting object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_path_template: description: The Jinja path representation of where the backup file will be found. The variable `obj` is available as the device instance object of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Backup Path in Jinja Template Form type: string backup_repository: format: uuid nullable: true type: string backup_test_connectivity: description: Whether or not to pretest the connectivity of the device by verifying there is a resolvable IP that can connect to port 22. title: Backup Test type: boolean custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dynamic_group: $ref: '#/components/schemas/NestedDynamicGroupRequest' id: format: uuid type: string intended_path_template: description: The Jinja path representation of where the generated file will be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Intended Path in Jinja Template Form type: string intended_repository: format: uuid nullable: true type: string jinja_path_template: description: The Jinja path representation of where the Jinja template can be found. e.g. `{{obj.platform.slug}}.j2` maxLength: 255 title: Template Path in Jinja Template Form type: string jinja_repository: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string scope: additionalProperties: {} type: object slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string sot_agg_query: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array weight: maximum: 32767 minimum: 0 type: integer required: - id - name - slug type: object BulkWritableGraphQLQueryRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string query: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string variables: additionalProperties: {} default: {} nullable: true type: object required: - id - name - query type: object BulkWritableGroupRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: id: type: integer name: maxLength: 150 minLength: 1 type: string required: - id - name type: object BulkWritableHardwareLCMRequest: description: API serializer. properties: custom_fields: additionalProperties: {} type: object device_type: allOf: - $ref: '#/components/schemas/NestedDeviceTypeRequest' description: Device Type to attach the Hardware LCM to documentation_url: format: uri maxLength: 200 type: string end_of_sale: format: date nullable: true type: string end_of_security_patches: format: date nullable: true type: string end_of_support: format: date nullable: true type: string end_of_sw_releases: format: date nullable: true title: End of Software Releases type: string id: format: uuid type: string inventory_item: maxLength: 255 nullable: true title: Inventory Item Part type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device_type - id type: object BulkWritableIPAddressRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: address: minLength: 1 type: string assigned_object_id: format: uuid nullable: true type: string assigned_object_type: nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dns_name: description: Hostname or FQDN (not case-sensitive) maxLength: 255 pattern: ^[0-9A-Za-z._-]+$ type: string id: format: uuid type: string nat_inside: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: $ref: '#/components/schemas/RoleEnum' status: $ref: '#/components/schemas/IPAddressStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vrf: allOf: - $ref: '#/components/schemas/NestedVRFRequest' nullable: true required: - address - id - status type: object BulkWritableIPRangeRequest: description: IPRange Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string end_address: minLength: 1 type: string id: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start_address: minLength: 1 type: string status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array vrf: format: uuid nullable: true type: string required: - end_address - id - start_address type: object BulkWritableImageAttachmentRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string id: format: uuid type: string image: format: binary type: string image_height: maximum: 32767 minimum: 0 type: integer image_width: maximum: 32767 minimum: 0 type: integer name: maxLength: 50 type: string object_id: format: uuid type: string required: - content_type - id - image - image_height - image_width - object_id type: object BulkWritableInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' enabled: type: boolean id: format: uuid type: string label: description: Physical label maxLength: 64 type: string lag: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true mac_address: maxLength: 18 nullable: true type: string mgmt_only: description: This interface is used only for out-of-band management title: Management only type: boolean mode: $ref: '#/components/schemas/ModeEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: properties: name: maxLength: 64 minLength: 1 type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - name - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/InterfaceTypeChoices' untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true required: - device - id - name - status - type type: object BulkWritableInterfaceTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string mgmt_only: title: Management only type: boolean name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/InterfaceTypeChoices' required: - device_type - id - name - type type: object BulkWritableInventoryItemRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this item maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' discovered: description: This item was automatically discovered type: boolean id: format: uuid type: string label: description: Physical label maxLength: 64 type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturerRequest' nullable: true name: maxLength: 64 minLength: 1 type: string parent: format: uuid nullable: true type: string part_id: description: Manufacturer-assigned part identifier maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object serial: maxLength: 255 title: Serial number type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - id - name type: object BulkWritableJobHookRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object enabled: type: boolean id: format: uuid type: string job: description: The job that this job hook will initiate format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type_create: description: Call this job hook when a matching object is created. type: boolean type_delete: description: Call this job hook when a matching object is deleted. type: boolean type_update: description: Call this job hook when a matching object is updated. type: boolean required: - content_types - id - job - name type: object BulkWritableJobRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: approval_required: description: Whether the job requires approval from another user before running type: boolean approval_required_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean commit_default: description: Whether the job defaults to committing changes when run, or defaults to a dry-run type: boolean commit_default_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean custom_fields: additionalProperties: {} type: object description: description: Markdown formatting is supported type: string description_override: description: If set, the configured description will remain even if the underlying Job source code changes type: boolean enabled: description: Whether this job can be executed by users type: boolean grouping: description: Human-readable grouping that this job belongs to maxLength: 255 minLength: 1 type: string grouping_override: description: If set, the configured grouping will remain even if the underlying Job source code changes type: boolean has_sensitive_variables: description: Whether this job contains sensitive variables type: boolean has_sensitive_variables_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean hidden: description: Whether the job defaults to not being shown in the UI type: boolean hidden_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean id: format: uuid type: string name: description: Human-readable name of this job maxLength: 100 minLength: 1 type: string name_override: description: If set, the configured name will remain even if the underlying Job source code changes type: boolean read_only: description: Whether the job is prevented from making lasting changes to the database type: boolean read_only_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 320 pattern: ^[-a-zA-Z0-9_]+$ type: string soft_time_limit: description: Maximum runtime in seconds before the job will receive a SoftTimeLimitExceeded exception.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number soft_time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array task_queues: additionalProperties: {} description: Comma separated list of task queues that this job can run on. A blank list will use the default queue type: object task_queues_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean time_limit: description: Maximum runtime in seconds before the job will be forcibly terminated.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean required: - grouping - id - name type: object BulkWritableLocationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location_type: $ref: '#/components/schemas/NestedLocationTypeRequest' name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id - location_type - name - status type: object BulkWritableLocationTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string nestable: description: Allow Locations of this type to be parents/children of other Locations of this same type type: boolean parent: allOf: - $ref: '#/components/schemas/NestedLocationTypeRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableManufacturerRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableMinMaxValidationRuleRequest: description: Serializer for `MinMaxValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string id: format: uuid type: string max: description: When set, apply a maximum value contraint to the value of the model field. format: double nullable: true type: number min: description: When set, apply a minimum value contraint to the value of the model field. format: double nullable: true type: number name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_type - field - id - name - slug type: object BulkWritableNATPolicyRequest: description: NATPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - id - name type: object BulkWritableNATPolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/ZoneRequest' id: format: uuid type: string index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string original_destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array original_source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_source_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_source_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remark: type: boolean request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array translated_destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array translated_source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_source_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_source_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array required: - id - name type: object BulkWritableNoteRequest: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: assigned_object_id: format: uuid type: string assigned_object_type: type: string id: format: uuid type: string note: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - assigned_object_id - assigned_object_type - id - note type: object BulkWritableObjectPermissionRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: actions: additionalProperties: {} description: The list of actions granted by this permission type: object constraints: additionalProperties: {} description: Queryset filter matching the applicable objects of the selected type(s) nullable: true type: object description: maxLength: 200 type: string enabled: type: boolean groups: items: properties: name: maxLength: 150 minLength: 1 type: string required: - name type: object type: array id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string object_types: items: type: string type: array users: items: properties: username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string required: - username type: object type: array required: - actions - id - name - object_types type: object BulkWritablePeerEndpointRequest: description: REST API serializer for PeerEndpoint records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string peer_group: allOf: - $ref: '#/components/schemas/NestedPeerGroupRequest' nullable: true peering: allOf: - $ref: '#/components/schemas/NestedPeeringRequest' nullable: true secret: allOf: - $ref: '#/components/schemas/NestedSecretRequest' nullable: true source_interface: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true source_ip: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - peering type: object BulkWritablePeerGroupRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string secret: allOf: - $ref: '#/components/schemas/NestedSecretRequest' nullable: true source_interface: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true source_ip: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true template: allOf: - $ref: '#/components/schemas/NestedPeerGroupTemplateRequest' nullable: true required: - id - name type: object BulkWritablePeerGroupTemplateRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string secret: allOf: - $ref: '#/components/schemas/NestedSecretRequest' nullable: true required: - id - name type: object BulkWritablePeeringRequest: description: REST API serializer for Peering records. properties: custom_fields: additionalProperties: {} type: object id: format: uuid type: string status: $ref: '#/components/schemas/CircuitStatusChoices' required: - id - status type: object BulkWritablePeeringRoleRequest: description: REST API serializer for PeeringRole records. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritablePlatformRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturerRequest' nullable: true name: maxLength: 100 minLength: 1 type: string napalm_args: additionalProperties: {} description: Additional arguments to pass when initiating the NAPALM driver (JSON format) nullable: true title: NAPALM arguments type: object napalm_driver: description: The name of the NAPALM driver to use when interacting with devices maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritablePolicyRequest: description: Policy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - id - name type: object BulkWritablePolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object action: $ref: '#/components/schemas/ActionEnum' custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array destination_zone: $ref: '#/components/schemas/ZoneRequest' id: format: uuid type: string index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object request_id: maxLength: 100 nullable: true type: string source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array source_user_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array user_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object type: array required: - name type: object type: array source_users: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object type: array source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - action - id - name type: object BulkWritablePowerFeedRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: amperage: maximum: 32767 minimum: 1 type: integer comments: type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string max_utilization: description: Maximum permissible draw (percentage) maximum: 100 minimum: 1 type: integer name: maxLength: 100 minLength: 1 type: string phase: allOf: - $ref: '#/components/schemas/PhaseEnum' default: label: Single phase value: single-phase power_panel: $ref: '#/components/schemas/NestedPowerPanelRequest' rack: allOf: - $ref: '#/components/schemas/NestedRackRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/PowerFeedStatusChoices' supply: allOf: - $ref: '#/components/schemas/SupplyEnum' default: label: AC value: ac tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: allOf: - $ref: '#/components/schemas/PowerFeedTypeChoices' default: label: Primary value: primary voltage: maximum: 32767 minimum: -32768 type: integer required: - id - name - power_panel - status type: object BulkWritablePowerOutletRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' feed_leg: $ref: '#/components/schemas/FeedLegEnum' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: $ref: '#/components/schemas/NestedPowerPortRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PowerOutletTypeChoices' required: - device - id - name type: object BulkWritablePowerOutletTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' feed_leg: $ref: '#/components/schemas/FeedLegEnum' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: $ref: '#/components/schemas/NestedPowerPortTemplateRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PowerOutletTypeChoices' required: - device_type - id - name type: object BulkWritablePowerPanelRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string rack_group: allOf: - $ref: '#/components/schemas/NestedRackGroupRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: $ref: '#/components/schemas/NestedSiteRequest' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - site type: object BulkWritablePowerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PowerPortTypeChoices' required: - device - id - name type: object BulkWritablePowerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PowerPortTypeChoices' required: - device_type - id - name type: object BulkWritablePrefixRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string is_pool: description: All IP addresses within this prefix are considered usable title: Is a pool type: boolean location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedRoleRequest' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true status: $ref: '#/components/schemas/PrefixStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true vrf: allOf: - $ref: '#/components/schemas/NestedVRFRequest' nullable: true required: - id - prefix - status type: object BulkWritableProviderLCMRequest: description: API serializer. properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string email: format: email maxLength: 254 title: E-mail type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableProviderNetworkRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string provider: $ref: '#/components/schemas/NestedProviderRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - provider type: object BulkWritableProviderRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: account: maxLength: 100 title: Account number type: string admin_contact: type: string asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string noc_contact: type: string portal_url: format: uri maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableRIRRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string is_private: description: IP space managed by this RIR is considered private title: Private type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableRackGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedRackGroupRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: $ref: '#/components/schemas/NestedSiteRequest' slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name - site type: object BulkWritableRackRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this rack maxLength: 50 nullable: true type: string comments: type: string custom_fields: additionalProperties: {} type: object desc_units: description: Units are numbered top-to-bottom title: Descending units type: boolean facility_id: description: Locally-assigned identifier maxLength: 50 nullable: true type: string group: allOf: - $ref: '#/components/schemas/NestedRackGroupRequest' nullable: true id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string outer_depth: description: Outer dimension of rack (depth) maximum: 32767 minimum: 0 nullable: true type: integer outer_unit: $ref: '#/components/schemas/OuterUnitEnum' outer_width: description: Outer dimension of rack (width) maximum: 32767 minimum: 0 nullable: true type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedRackRoleRequest' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSiteRequest' status: $ref: '#/components/schemas/RackStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true type: $ref: '#/components/schemas/RackTypeChoices' u_height: description: Height in rack units maximum: 100 minimum: 1 title: Height (U) type: integer width: $ref: '#/components/schemas/WidthEnum' required: - id - name - site - status type: object BulkWritableRackReservationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 minLength: 1 type: string id: format: uuid type: string rack: $ref: '#/components/schemas/NestedRackRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true units: additionalProperties: {} type: object user: $ref: '#/components/schemas/NestedUserRequest' required: - description - id - rack - units - user type: object BulkWritableRackRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableRearPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' required: - device - id - name - type type: object BulkWritableRearPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' required: - device_type - id - name - type type: object BulkWritableRegionRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedRegionRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableRegularExpressionValidationRuleRequest: description: Serializer for `RegularExpressionValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string regular_expression: minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_type - field - id - name - regular_expression - slug type: object BulkWritableRelationshipAssociationRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: destination_id: format: uuid type: string destination_type: type: string id: format: uuid type: string relationship: $ref: '#/components/schemas/NestedRelationshipRequest' source_id: format: uuid type: string source_type: type: string required: - destination_id - destination_type - id - relationship - source_id - source_type type: object BulkWritableRelationshipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string destination_filter: additionalProperties: {} description: Filterset filter matching the applicable destination objects of the selected type nullable: true type: object destination_hidden: description: Hide this relationship on the destination object. title: Hide for destination object type: boolean destination_label: description: Label for related source objects, as displayed on the destination object. maxLength: 50 type: string destination_type: type: string id: format: uuid type: string name: description: Name of the relationship as displayed to users maxLength: 100 minLength: 1 type: string required_on: description: Objects on the specified side MUST implement this relationship. Not permitted for symmetric relationships. oneOf: - $ref: '#/components/schemas/RequiredOnEnum' - $ref: '#/components/schemas/BlankEnum' slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string source_filter: additionalProperties: {} description: Filterset filter matching the applicable source objects of the selected type nullable: true type: object source_hidden: description: Hide this relationship on the source object. title: Hide for source object type: boolean source_label: description: Label for related destination objects, as displayed on the source object. maxLength: 50 type: string source_type: type: string type: allOf: - $ref: '#/components/schemas/RelationshipTypeChoices' description: Cardinality of this relationship required: - destination_type - id - name - source_type type: object BulkWritableRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string weight: maximum: 32767 minimum: 0 type: integer required: - id - name type: object BulkWritableRouteTargetRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id - name type: object BulkWritableSecretRequest: description: Serializer for `Secret` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parameters: additionalProperties: {} type: object provider: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name - provider type: object BulkWritableSecretsGroupAssociationRequest: description: Serializer for `SecretsGroupAssociation` objects. properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' group: $ref: '#/components/schemas/NestedSecretsGroupRequest' id: format: uuid type: string secret: $ref: '#/components/schemas/NestedSecretRequest' secret_type: $ref: '#/components/schemas/SecretTypeEnum' required: - access_type - group - id - secret - secret_type type: object BulkWritableSecretsGroupRequest: description: Serializer for `SecretsGroup` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableServiceObjectGroupRequest: description: ServiceObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableServiceObjectRequest: description: ServiceObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string ip_protocol: allOf: - $ref: '#/components/schemas/IpProtocolEnum' description: IANA IP Protocol (e.g. TCP UDP ICMP) name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - ip_protocol - name type: object BulkWritableServiceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true id: format: uuid type: string ipaddresses: items: properties: address: minLength: 1 type: string required: - address type: object type: array name: maxLength: 100 minLength: 1 type: string ports: items: maximum: 65535 minimum: 1 type: integer type: array protocol: $ref: '#/components/schemas/ProtocolEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array virtual_machine: allOf: - $ref: '#/components/schemas/NestedVirtualMachineRequest' nullable: true required: - id - name - ports type: object BulkWritableSiteRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string contact_email: format: email maxLength: 254 title: Contact E-mail type: string contact_name: maxLength: 50 type: string contact_phone: maxLength: 20 type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string facility: description: Local facility ID or description maxLength: 50 type: string id: format: uuid type: string latitude: description: GPS coordinate (latitude) format: decimal nullable: true pattern: ^-?\d{0,2}(?:\.\d{0,6})?$ type: string longitude: description: GPS coordinate (longitude) format: decimal nullable: true pattern: ^-?\d{0,3}(?:\.\d{0,6})?$ type: string name: maxLength: 100 minLength: 1 type: string physical_address: maxLength: 200 type: string region: allOf: - $ref: '#/components/schemas/NestedRegionRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object shipping_address: maxLength: 200 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true time_zone: nullable: true type: string required: - id - name - status type: object BulkWritableSoftwareImageLCMRequest: description: REST API serializer for SoftwareImageLCM records. properties: custom_fields: additionalProperties: {} type: object default_image: type: boolean device_types: items: format: uuid type: string type: array download_url: format: uri maxLength: 200 type: string id: format: uuid type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 minLength: 1 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: $ref: '#/components/schemas/NestedSoftwareLCMRequest' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - image_file_name - software type: object BulkWritableSoftwareLCMRequest: description: REST API serializer for SoftwareLCM records. properties: alias: maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object device_platform: $ref: '#/components/schemas/NestedPlatformRequest' documentation_url: format: uri maxLength: 200 type: string end_of_support: format: date nullable: true title: End of Software Support type: string id: format: uuid type: string long_term_support: type: boolean pre_release: type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string software_images: items: properties: default_image: type: boolean device_types: items: format: uuid type: string type: array download_url: format: uri maxLength: 200 type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 minLength: 1 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array required: - image_file_name type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array version: maxLength: 50 minLength: 1 type: string required: - device_platform - id - version type: object BulkWritableStatusRequest: description: Serializer for `Status` objects. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: maxLength: 50 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_types - id - name type: object BulkWritableTagSerializerVersion13Request: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 minLength: 1 pattern: ^[-\w]+$ type: string required: - content_types - id - name - slug type: object BulkWritableTenantGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedTenantGroupRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableTenantRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: $ref: '#/components/schemas/NestedTenantGroupRequest' id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableTokenRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string expires: format: date-time nullable: true type: string id: format: uuid type: string key: maxLength: 40 minLength: 40 type: string write_enabled: description: Permit create/update/delete operations using this key type: boolean required: - id type: object BulkWritableUserObjectGroupRequest: description: UserObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array user_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object type: array required: - id - name type: object BulkWritableUserObjectRequest: description: UserObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - id - username type: object BulkWritableUserRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: date_joined: format: date-time type: string email: format: email maxLength: 254 title: Email address type: string first_name: maxLength: 150 type: string groups: items: properties: name: maxLength: 150 minLength: 1 type: string required: - name type: object type: array id: format: uuid type: string is_active: description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. title: Active type: boolean is_staff: description: Designates whether the user can log into this admin site. title: Staff status type: boolean last_name: maxLength: 150 type: string password: maxLength: 128 minLength: 1 type: string writeOnly: true username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string required: - id - password - username type: object BulkWritableVLANGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id - name type: object BulkWritableVLANRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: allOf: - $ref: '#/components/schemas/NestedVLANGroupRequest' nullable: true id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedRoleRequest' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true status: $ref: '#/components/schemas/VLANStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vid: maximum: 4094 minimum: 1 title: ID type: integer required: - id - name - status - vid type: object BulkWritableVMInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedVMInterfaceRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean id: format: uuid type: string mac_address: maxLength: 18 nullable: true type: string mode: $ref: '#/components/schemas/ModeEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedVMInterfaceRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: properties: name: maxLength: 64 minLength: 1 type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - name - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true virtual_machine: $ref: '#/components/schemas/NestedVirtualMachineRequest' required: - id - name - status - virtual_machine type: object BulkWritableVRFRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enforce_unique: description: Prevent duplicate prefixes/IP addresses within this VRF title: Enforce unique space type: boolean export_targets: items: properties: name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string required: - name type: object type: array id: format: uuid type: string import_targets: items: properties: name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string required: - name type: object type: array name: maxLength: 100 minLength: 1 type: string rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id - name type: object BulkWritableValidatedSoftwareLCMRequest: description: REST API serializer for ValidatedSoftwareLCM records. properties: custom_fields: additionalProperties: {} type: object device_roles: items: format: uuid type: string type: array device_types: items: format: uuid type: string type: array devices: items: format: uuid type: string type: array end: format: date nullable: true title: Valid Until type: string id: format: uuid type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array preferred: title: Preferred Version type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: $ref: '#/components/schemas/NestedSoftwareLCMRequest' start: format: date title: Valid Since type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - software - start type: object BulkWritableVirtualChassisRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object domain: maxLength: 30 type: string id: format: uuid type: string master: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object BulkWritableVirtualMachineWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster: $ref: '#/components/schemas/NestedClusterRequest' comments: type: string custom_fields: additionalProperties: {} type: object disk: maximum: 2147483647 minimum: 0 nullable: true title: Disk (GB) type: integer id: format: uuid type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchemaRequest' nullable: true memory: maximum: 2147483647 minimum: 0 nullable: true title: Memory (MB) type: integer name: maxLength: 64 minLength: 1 type: string platform: allOf: - $ref: '#/components/schemas/NestedPlatformRequest' nullable: true primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedDeviceRoleRequest' nullable: true status: $ref: '#/components/schemas/VirtualMachineStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vcpus: maximum: 32767 minimum: 0 nullable: true type: integer required: - cluster - id - name - status type: object BulkWritableVulnerabilityLCMRequest: description: REST API serializer for VulnerabilityLCM records. properties: custom_fields: additionalProperties: {} type: object id: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - status type: object BulkWritableWebhookRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: additional_headers: description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is support with the same context as the request body (below).' type: string body_template: description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.' type: string ca_file_path: description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. maxLength: 4096 nullable: true type: string content_types: items: type: string type: array http_content_type: description: The complete list of official content types is available here. maxLength: 100 minLength: 1 type: string http_method: $ref: '#/components/schemas/HttpMethodEnum' id: format: uuid type: string name: maxLength: 150 minLength: 1 type: string payload_url: description: A POST will be sent to this URL when the webhook is called. maxLength: 500 minLength: 1 title: URL type: string secret: description: When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. maxLength: 255 type: string ssl_verification: description: Enable SSL certificate verification. Disable with caution! type: boolean type_create: description: Call this webhook when a matching object is created. type: boolean type_delete: description: Call this webhook when a matching object is deleted. type: boolean type_update: description: Call this webhook when a matching object is updated. type: boolean required: - content_types - id - name - payload_url type: object BulkWritableZoneRequest: description: Zone Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string interfaces: items: $ref: '#/components/schemas/NestedInterfaceRequest' type: array name: description: Name of the zone (e.g. trust) maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id - name type: object ButtonClassEnum: enum: - default - primary - success - info - warning - danger - link type: string CVELCM: description: REST API serializer for CVELCM records. properties: comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string display: description: Human friendly display value readOnly: true type: string fix: maxLength: 255 nullable: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string link: format: uri maxLength: 200 type: string name: maxLength: 16 type: string published_date: format: date type: string severity: properties: label: enum: - Critical - High - Medium - Low - None type: string value: enum: - Critical - High - Medium - Low - None type: string type: object status: properties: label: enum: [] type: string value: enum: [] type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - link - name - published_date - url type: object Cable: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: maxLength: 100 type: string last_updated: format: date-time nullable: true readOnly: true type: string length: maximum: 32767 minimum: 0 nullable: true type: integer length_unit: properties: label: enum: - Meters - Centimeters - Feet - Inches type: string value: enum: - m - cm - ft - in type: string type: object notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Connected - Decommissioning - Planned type: string value: enum: - connected - decommissioning - planned type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array termination_a: additionalProperties: {} nullable: true readOnly: true type: object termination_a_id: format: uuid type: string termination_a_type: type: string termination_b: additionalProperties: {} nullable: true readOnly: true type: object termination_b_id: format: uuid type: string termination_b_type: type: string type: oneOf: - $ref: '#/components/schemas/CableTypeChoices' - $ref: '#/components/schemas/BlankEnum' url: format: uri readOnly: true type: string required: - created - display - id - last_updated - notes_url - status - termination_a - termination_a_id - termination_a_type - termination_b - termination_b_id - termination_b_type - url type: object CableStatusChoices: enum: - connected - decommissioning - planned type: string CableTypeChoices: enum: - cat3 - cat5 - cat5e - cat6 - cat6a - cat7 - cat7a - cat8 - dac-active - dac-passive - mrj21-trunk - coaxial - mmf - mmf-om1 - mmf-om2 - mmf-om3 - mmf-om4 - smf - smf-os1 - smf-os2 - aoc - power type: string CapircaPolicy: description: CapircaPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object cfg: nullable: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device: format: uuid nullable: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string net: nullable: true type: string pol: nullable: true type: string svc: nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - url type: object CapircaPolicyRequest: description: CapircaPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object cfg: nullable: true type: string custom_fields: additionalProperties: {} type: object device: format: uuid nullable: true type: string net: nullable: true type: string pol: nullable: true type: string svc: nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object Circuit: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cid: maxLength: 100 title: Circuit ID type: string comments: type: string commit_rate: maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string install_date: format: date nullable: true title: Date installed type: string last_updated: format: date-time nullable: true readOnly: true type: string notes_url: format: uri readOnly: true type: string provider: $ref: '#/components/schemas/NestedProvider' status: properties: label: enum: - Active - Decommissioned - Deprovisioning - Offline - Planned - Provisioning type: string value: enum: - active - decommissioned - deprovisioning - offline - planned - provisioning type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true termination_a: allOf: - $ref: '#/components/schemas/CircuitCircuitTermination' readOnly: true termination_z: allOf: - $ref: '#/components/schemas/CircuitCircuitTermination' readOnly: true type: $ref: '#/components/schemas/NestedCircuitType' url: format: uri readOnly: true type: string required: - cid - created - display - id - last_updated - notes_url - provider - status - termination_a - termination_z - type - url type: object CircuitCircuitTermination: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: connected_endpoint: $ref: '#/components/schemas/NestedInterface' created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true notes_url: format: uri readOnly: true type: string port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer provider_network: $ref: '#/components/schemas/NestedProviderNetwork' site: $ref: '#/components/schemas/NestedSite' upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer url: format: uri readOnly: true type: string xconnect_id: maxLength: 50 title: Cross-connect ID type: string required: - connected_endpoint - created - display - id - last_updated - notes_url - provider_network - site - url type: object CircuitCircuitTerminationRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: connected_endpoint: $ref: '#/components/schemas/NestedInterfaceRequest' location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer provider_network: $ref: '#/components/schemas/NestedProviderNetworkRequest' site: $ref: '#/components/schemas/NestedSiteRequest' upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer xconnect_id: maxLength: 50 title: Cross-connect ID type: string required: - id type: object CircuitMaintenance: description: Serializer for API. properties: ack: nullable: true type: boolean description: nullable: true type: string end_time: format: date-time type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string start_time: format: date-time type: string status: nullable: true oneOf: - $ref: '#/components/schemas/StatusD95Enum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - end_time - id - start_time type: object CircuitMaintenanceCircuitImpact: description: Serializer for API. properties: circuit: format: uuid type: string id: format: uuid readOnly: true type: string impact: nullable: true oneOf: - $ref: '#/components/schemas/ImpactEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' maintenance: format: uuid type: string required: - circuit - id - maintenance type: object CircuitMaintenanceCircuitImpactRequest: description: Serializer for API. properties: circuit: format: uuid type: string impact: nullable: true oneOf: - $ref: '#/components/schemas/ImpactEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' maintenance: format: uuid type: string required: - circuit - maintenance type: object CircuitMaintenanceRequest: description: Serializer for API. properties: ack: nullable: true type: boolean description: nullable: true type: string end_time: format: date-time type: string name: maxLength: 100 minLength: 1 type: string start_time: format: date-time type: string status: nullable: true oneOf: - $ref: '#/components/schemas/StatusD95Enum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - end_time - start_time type: object CircuitStatusChoices: enum: - active - decommissioned - deprovisioning - offline - planned - provisioning type: string CircuitTermination: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string circuit: $ref: '#/components/schemas/NestedCircuit' connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true notes_url: format: uri readOnly: true type: string port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer pp_info: maxLength: 100 title: Patch panel/port(s) type: string provider_network: allOf: - $ref: '#/components/schemas/NestedProviderNetwork' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSite' nullable: true term_side: allOf: - $ref: '#/components/schemas/TermSideEnum' title: Termination upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer url: format: uri readOnly: true type: string xconnect_id: maxLength: 50 title: Cross-connect ID type: string required: - cable - cable_peer - cable_peer_type - circuit - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - created - display - id - last_updated - notes_url - term_side - url type: object CircuitType: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: circuit_count: readOnly: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - circuit_count - created - display - id - last_updated - name - notes_url - url type: object CircuitTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object Cluster: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string group: allOf: - $ref: '#/components/schemas/NestedClusterGroup' nullable: true id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string site: allOf: - $ref: '#/components/schemas/NestedSite' nullable: true tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true type: $ref: '#/components/schemas/NestedClusterType' url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - created - device_count - display - id - last_updated - name - notes_url - type - url - virtualmachine_count type: object ClusterGroup: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster_count: readOnly: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - cluster_count - created - display - id - last_updated - name - notes_url - url type: object ClusterGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object ClusterType: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster_count: readOnly: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - cluster_count - created - display - id - last_updated - name - notes_url - url type: object ClusterTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object CommandToken: description: API serializer for interacting with CommandToken objects. properties: comment: description: 'Optional: Enter description of token' maxLength: 255 type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string platform: $ref: '#/components/schemas/PlatformEnum' token: description: Token given by chat platform for signing or command validation maxLength: 255 type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - platform - token - url type: object CommandTokenRequest: description: API serializer for interacting with CommandToken objects. properties: comment: description: 'Optional: Enter description of token' maxLength: 255 type: string platform: $ref: '#/components/schemas/PlatformEnum' token: description: Token given by chat platform for signing or command validation maxLength: 255 minLength: 1 type: string required: - platform - token type: object ComplianceFeature: description: Serializer for ComplianceFeature object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - slug - url type: object ComplianceFeatureRequest: description: Serializer for ComplianceFeature object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - slug type: object ComplianceRule: description: Serializer for ComplianceRule object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object config_ordered: description: Whether or not the configuration order matters, such as in ACLs. title: Configured Ordered type: boolean config_type: allOf: - $ref: '#/components/schemas/ConfigTypeEnum' description: Whether the config is in cli or json/structured format. created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string feature: format: uuid type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string match_config: description: The config to match that is matched based on the parent most configuration. e.g. `router bgp` or `ntp`. nullable: true title: Config to Match type: string platform: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - config_ordered - created - display - feature - id - last_updated - platform - url type: object ComplianceRuleRequest: description: Serializer for ComplianceRule object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object config_ordered: description: Whether or not the configuration order matters, such as in ACLs. title: Configured Ordered type: boolean config_type: allOf: - $ref: '#/components/schemas/ConfigTypeEnum' description: Whether the config is in cli or json/structured format. custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string feature: format: uuid type: string match_config: description: The config to match that is matched based on the parent most configuration. e.g. `router bgp` or `ntp`. nullable: true title: Config to Match type: string platform: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - config_ordered - feature - platform type: object ComputedField: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string created: format: date nullable: true readOnly: true type: string description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fallback_value: description: Fallback value (if any) to be output for the field in the case of a template rendering error. maxLength: 500 type: string id: format: uuid readOnly: true type: string label: description: Name of the field as displayed to users maxLength: 100 type: string last_updated: format: date-time nullable: true readOnly: true type: string notes_url: format: uri readOnly: true type: string slug: description: Internal field name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string template: description: Jinja2 template code for field value maxLength: 500 type: string url: format: uri readOnly: true type: string weight: maximum: 32767 minimum: 0 type: integer required: - content_type - created - display - id - label - last_updated - notes_url - template - url type: object ComputedFieldRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string description: maxLength: 200 type: string fallback_value: description: Fallback value (if any) to be output for the field in the case of a template rendering error. maxLength: 500 type: string label: description: Name of the field as displayed to users maxLength: 100 minLength: 1 type: string slug: description: Internal field name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string template: description: Jinja2 template code for field value maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer required: - content_type - label - template type: object ConfigCompliance: description: Serializer for ConfigCompliance object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object actual: additionalProperties: {} description: Actual Configuration for feature type: object compliance: nullable: true type: boolean compliance_int: maximum: 2147483647 minimum: -2147483648 nullable: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device: description: The device format: uuid type: string display: description: Human friendly display value readOnly: true type: string extra: additionalProperties: {} description: Configuration that should not be on the device. type: object id: format: uuid readOnly: true type: string intended: additionalProperties: {} description: Intended Configuration for feature type: object last_updated: format: date-time nullable: true readOnly: true type: string missing: additionalProperties: {} description: Configuration that should be on the device. type: object ordered: type: boolean rule: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array required: - created - device - display - id - last_updated - rule type: object ConfigComplianceRequest: description: Serializer for ConfigCompliance object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object actual: additionalProperties: {} description: Actual Configuration for feature type: object compliance: nullable: true type: boolean compliance_int: maximum: 2147483647 minimum: -2147483648 nullable: true type: integer custom_fields: additionalProperties: {} type: object device: description: The device format: uuid type: string extra: additionalProperties: {} description: Configuration that should not be on the device. type: object intended: additionalProperties: {} description: Intended Configuration for feature type: object missing: additionalProperties: {} description: Configuration that should be on the device. type: object ordered: type: boolean rule: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - rule type: object ConfigContext: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: cluster_groups: items: properties: cluster_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - cluster_count - display - id - name - url type: object type: array clusters: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - display - id - name - url - virtualmachine_count type: object type: array created: format: date nullable: true readOnly: true type: string data: additionalProperties: {} type: object description: maxLength: 200 type: string device_types: items: properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturer' readOnly: true model: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - device_count - display - id - manufacturer - model - slug - url type: object type: array display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string is_active: type: boolean last_updated: format: date-time nullable: true readOnly: true type: string locations: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tree_depth: nullable: true readOnly: true type: integer url: format: uri readOnly: true type: string required: - display - id - name - tree_depth - url type: object type: array name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string owner: additionalProperties: {} nullable: true readOnly: true type: object owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string platforms: items: properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - device_count - display - id - name - url - virtualmachine_count type: object type: array regions: items: properties: _depth: readOnly: true title: ' depth' type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string site_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - _depth - display - id - name - site_count - url type: object type: array roles: items: properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - device_count - display - id - name - url - virtualmachine_count type: object type: array schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchema' nullable: true sites: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object type: array tags: items: type: string type: array tenant_groups: items: properties: _depth: readOnly: true title: ' depth' type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tenant_count: readOnly: true type: integer url: format: uri readOnly: true type: string required: - _depth - display - id - name - tenant_count - url type: object type: array tenants: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object type: array url: format: uri readOnly: true type: string weight: maximum: 32767 minimum: 0 type: integer required: - created - data - display - id - last_updated - name - notes_url - owner - url type: object ConfigContextSchema: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object data_schema: additionalProperties: {} description: A JSON Schema document which is used to validate a config context object. type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 200 type: string notes_url: format: uri readOnly: true type: string owner: additionalProperties: {} nullable: true readOnly: true type: object owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - created - data_schema - display - id - last_updated - name - notes_url - owner - url type: object ConfigContextSchemaRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object data_schema: additionalProperties: {} description: A JSON Schema document which is used to validate a config context object. type: object description: maxLength: 200 type: string name: maxLength: 200 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - data_schema - name type: object ConfigRemove: description: Serializer for ConfigRemove object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 255 type: string platform: format: uuid type: string regex: description: Regex pattern used to remove a line from the backup configuration. maxLength: 200 title: Regex Pattern type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - platform - regex - url type: object ConfigRemoveRequest: description: Serializer for ConfigRemove object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern used to remove a line from the backup configuration. maxLength: 200 minLength: 1 title: Regex Pattern type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - platform - regex type: object ConfigReplace: description: Serializer for ConfigReplace object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 255 type: string platform: format: uuid type: string regex: description: Regex pattern that will be found and replaced with 'replaced text'. maxLength: 200 title: Regex Pattern to Substitute type: string replace: description: Text that will be inserted in place of Regex pattern match. maxLength: 200 title: Replaced Text type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - platform - regex - replace - url type: object ConfigReplaceRequest: description: Serializer for ConfigReplace object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern that will be found and replaced with 'replaced text'. maxLength: 200 minLength: 1 title: Regex Pattern to Substitute type: string replace: description: Text that will be inserted in place of Regex pattern match. maxLength: 200 minLength: 1 title: Replaced Text type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - platform - regex - replace type: object ConfigToPush: description: Serializer for ConfigToPush view. properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: allOf: - $ref: '#/components/schemas/NestedCluster' nullable: true comments: type: string config: readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: allOf: - $ref: '#/components/schemas/NestedDeviceRedundancyGroup' nullable: true device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: $ref: '#/components/schemas/NestedDeviceRole' device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string face: properties: label: enum: - Front - Rear type: string value: enum: - front - rear type: string type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchema' nullable: true location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 64 nullable: true type: string notes_url: format: uri readOnly: true type: string parent_device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true platform: allOf: - $ref: '#/components/schemas/NestedPlatform' nullable: true position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip: allOf: - $ref: '#/components/schemas/NestedIPAddress' readOnly: true primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true rack: allOf: - $ref: '#/components/schemas/NestedRack' nullable: true secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroup' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSite' status: properties: label: enum: - Active - Decommissioning - Failed - Inventory - Offline - Planned - Staged type: string value: enum: - active - decommissioning - failed - inventory - offline - planned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: allOf: - $ref: '#/components/schemas/NestedVirtualChassis' nullable: true required: - config - created - device_role - device_type - display - id - last_updated - notes_url - parent_device - primary_ip - site - status - url type: object ConfigTypeEnum: enum: - cli - json - custom type: string ConsolePort: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - Other type: string value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - other type: string type: object url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - created - device - display - id - last_updated - name - notes_url - url type: object ConsolePortTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string type: properties: label: enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - Other type: string value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - other type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - url type: object ConsolePortTypeChoices: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - other type: string ConsoleServerPort: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - Other type: string value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - other type: string type: object url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - created - device - display - id - last_updated - name - notes_url - url type: object ConsoleServerPortTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string type: properties: label: enum: - DE-9 - DB-25 - RJ-11 - RJ-12 - RJ-45 - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - Other type: string value: enum: - de-9 - db-25 - rj-11 - rj-12 - rj-45 - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - other type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - url type: object ContactLCM: description: API serializer. properties: address: maxLength: 200 type: string comments: type: string contract: allOf: - $ref: '#/components/schemas/NestedContractLCM' description: Associated Contract created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string email: format: email maxLength: 254 title: Contact E-mail type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 80 nullable: true type: string phone: maxLength: 20 type: string priority: maximum: 2147483647 minimum: 0 type: integer tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - contract - created - display - id - last_updated - name - url type: object ContentType: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: app_label: maxLength: 100 type: string display: readOnly: true type: string id: readOnly: true type: integer model: maxLength: 100 title: Python model class name type: string url: format: uri readOnly: true type: string required: - app_label - display - id - model - url type: object ContractLCM: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string end: format: date nullable: true title: Contract End Date type: string expired: readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderLCM' description: Vendor start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - expired - id - last_updated - name - provider - url type: object CustomFieldChoice: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string field: $ref: '#/components/schemas/NestedCustomField' id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string url: format: uri readOnly: true type: string value: maxLength: 100 type: string weight: description: Higher weights appear later in the list maximum: 32767 minimum: 0 type: integer required: - created - display - field - id - last_updated - url - value type: object CustomFieldSerializerVersion12: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_types: items: type: string type: array created: format: date nullable: true readOnly: true type: string default: additionalProperties: {} description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo"). nullable: true type: object description: description: A helpful description for this field. maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string filter_logic: properties: label: enum: - Disabled - Loose - Exact type: string value: enum: - disabled - loose - exact type: string type: object id: format: uuid readOnly: true type: string label: maxLength: 50 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Human-readable unique name of this field. maxLength: 50 type: string notes_url: format: uri readOnly: true type: string required: description: If true, this field is required when creating new objects or editing an existing object. type: boolean slug: maxLength: 50 type: string type: properties: label: enum: - Text - Integer - Boolean (true/false) - Date - URL - Selection - Multiple selection - JSON type: string value: enum: - text - integer - boolean - date - url - select - multi-select - json type: string type: object url: format: uri readOnly: true type: string validation_maximum: description: Maximum allowed value (for numeric fields). format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true title: Maximum value type: integer validation_minimum: description: Minimum allowed value (for numeric fields). format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true title: Minimum value type: integer validation_regex: description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters. Regular expression on select and multi-select will be applied at Custom Field Choices definition. maxLength: 500 type: string weight: description: Fields with higher weights appear lower in a form. maximum: 32767 minimum: 0 type: integer required: - content_types - created - display - id - last_updated - name - notes_url - type - url type: object CustomFieldSerializerVersion12Request: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_types: items: type: string type: array default: additionalProperties: {} description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo"). nullable: true type: object description: description: A helpful description for this field. maxLength: 200 type: string filter_logic: $ref: '#/components/schemas/FilterLogicEnum' label: maxLength: 50 minLength: 1 type: string name: description: Human-readable unique name of this field. maxLength: 50 minLength: 1 type: string required: description: If true, this field is required when creating new objects or editing an existing object. type: boolean slug: maxLength: 50 minLength: 1 type: string type: $ref: '#/components/schemas/CustomFieldTypeChoices' validation_maximum: description: Maximum allowed value (for numeric fields). format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true title: Maximum value type: integer validation_minimum: description: Minimum allowed value (for numeric fields). format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true title: Minimum value type: integer validation_regex: description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters. Regular expression on select and multi-select will be applied at Custom Field Choices definition. maxLength: 500 type: string weight: description: Fields with higher weights appear lower in a form. maximum: 32767 minimum: 0 type: integer required: - id type: object CustomFieldTypeChoices: enum: - text - integer - boolean - date - url - select - multi-select - json type: string CustomLink: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: button_class: allOf: - $ref: '#/components/schemas/ButtonClassEnum' description: The class of the first link in a group will be used for the dropdown button content_type: type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string group_name: description: Links with the same group will appear as a dropdown menu maxLength: 50 type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string new_window: description: Force link to open in a new window type: boolean notes_url: format: uri readOnly: true type: string target_url: description: Jinja2 template code for link URL. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. maxLength: 500 title: URL type: string text: description: Jinja2 template code for link text. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. Links which render as empty text will not be displayed. maxLength: 500 type: string url: format: uri readOnly: true type: string weight: maximum: 32767 minimum: 0 type: integer required: - content_type - created - display - id - last_updated - name - new_window - notes_url - target_url - text - url type: object CustomLinkRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: button_class: allOf: - $ref: '#/components/schemas/ButtonClassEnum' description: The class of the first link in a group will be used for the dropdown button content_type: type: string group_name: description: Links with the same group will appear as a dropdown menu maxLength: 50 type: string name: maxLength: 100 minLength: 1 type: string new_window: description: Force link to open in a new window type: boolean target_url: description: Jinja2 template code for link URL. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. maxLength: 500 minLength: 1 title: URL type: string text: description: Jinja2 template code for link text. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. Links which render as empty text will not be displayed. maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer required: - content_type - name - new_window - target_url - text type: object Device: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: allOf: - $ref: '#/components/schemas/NestedCluster' nullable: true comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: allOf: - $ref: '#/components/schemas/NestedDeviceRedundancyGroup' nullable: true device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: $ref: '#/components/schemas/NestedDeviceRole' device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string face: properties: label: enum: - Front - Rear type: string value: enum: - front - rear type: string type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchema' nullable: true location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 64 nullable: true type: string notes_url: format: uri readOnly: true type: string parent_device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true platform: allOf: - $ref: '#/components/schemas/NestedPlatform' nullable: true position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip: allOf: - $ref: '#/components/schemas/NestedIPAddress' readOnly: true primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true rack: allOf: - $ref: '#/components/schemas/NestedRack' nullable: true secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroup' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSite' status: properties: label: enum: - Active - Decommissioning - Failed - Inventory - Offline - Planned - Staged type: string value: enum: - active - decommissioning - failed - inventory - offline - planned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: allOf: - $ref: '#/components/schemas/NestedVirtualChassis' nullable: true required: - created - device_role - device_type - display - id - last_updated - notes_url - parent_device - primary_ip - site - status - url type: object DeviceBay: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string installed_device: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - device - display - id - last_updated - name - notes_url - url type: object DeviceBayTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - url type: object DeviceNAPALM: properties: method: additionalProperties: {} type: object required: - method type: object DeviceRedundancyGroup: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string failover_strategy: properties: label: enum: - Active/Active - Active/Passive type: string value: enum: - active-active - active-passive type: string type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: properties: label: enum: - Active - Decommissioning - Planned - Retired - Staging type: string value: enum: - active - decommissioning - planned - retired - staging type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - failover_strategy - id - last_updated - name - notes_url - status - url type: object DeviceRole: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer vm_role: description: Virtual machines may be assigned to this role type: boolean required: - created - device_count - display - id - last_updated - name - notes_url - url - virtualmachine_count type: object DeviceRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string vm_role: description: Virtual machines may be assigned to this role type: boolean required: - name type: object DeviceStatusChoices: enum: - active - decommissioning - failed - inventory - offline - planned - staged type: string DeviceType: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string front_image: format: uri type: string id: format: uuid readOnly: true type: string is_full_depth: description: Device consumes both front and rear rack faces type: boolean last_updated: format: date-time nullable: true readOnly: true type: string manufacturer: $ref: '#/components/schemas/NestedManufacturer' model: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string part_number: description: Discrete part number (optional) maxLength: 50 type: string rear_image: format: uri type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string subdevice_role: properties: label: enum: - Parent - Child type: string value: enum: - parent - child type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array u_height: maximum: 32767 minimum: 0 title: Height (U) type: integer url: format: uri readOnly: true type: string required: - created - device_count - display - id - last_updated - manufacturer - model - notes_url - url type: object DeviceWithConfigContext: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: allOf: - $ref: '#/components/schemas/NestedCluster' nullable: true comments: type: string config_context: additionalProperties: {} readOnly: true type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: allOf: - $ref: '#/components/schemas/NestedDeviceRedundancyGroup' nullable: true device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: $ref: '#/components/schemas/NestedDeviceRole' device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string face: properties: label: enum: - Front - Rear type: string value: enum: - front - rear type: string type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchema' nullable: true location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 64 nullable: true type: string notes_url: format: uri readOnly: true type: string parent_device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true platform: allOf: - $ref: '#/components/schemas/NestedPlatform' nullable: true position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip: allOf: - $ref: '#/components/schemas/NestedIPAddress' readOnly: true primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true rack: allOf: - $ref: '#/components/schemas/NestedRack' nullable: true secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroup' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSite' status: properties: label: enum: - Active - Decommissioning - Failed - Inventory - Offline - Planned - Staged type: string value: enum: - active - decommissioning - failed - inventory - offline - planned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: allOf: - $ref: '#/components/schemas/NestedVirtualChassis' nullable: true required: - config_context - created - device_role - device_type - display - id - last_updated - notes_url - parent_device - primary_ip - site - status - url type: object DynamicGroup: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: children: items: $ref: '#/components/schemas/NestedDynamicGroupMembership' readOnly: true type: array content_type: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string filter: additionalProperties: {} description: A JSON-encoded dictionary of filter parameters for group membership type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Dynamic Group name maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - children - content_type - created - display - filter - id - last_updated - name - notes_url - url type: object DynamicGroupMembership: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: display: description: Human friendly display value readOnly: true type: string group: $ref: '#/components/schemas/NestedDynamicGroup' id: format: uuid readOnly: true type: string operator: $ref: '#/components/schemas/OperatorEnum' parent_group: $ref: '#/components/schemas/NestedDynamicGroup' url: format: uri readOnly: true type: string weight: maximum: 32767 minimum: 0 type: integer required: - display - group - id - operator - parent_group - url - weight type: object DynamicGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_type: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string filter: additionalProperties: {} description: A JSON-encoded dictionary of filter parameters for group membership type: object name: description: Dynamic Group name maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_type - filter - name type: object ExportTemplate: description: Extend ValidatedModelSerializer with a `relationships` field. properties: content_type: type: string created: format: date nullable: true readOnly: true type: string description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string file_extension: description: Extension to append to the rendered filename maxLength: 15 type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string mime_type: description: Defaults to text/plain maxLength: 50 type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string owner: additionalProperties: {} nullable: true readOnly: true type: object owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string template_code: description: The list of objects being exported is passed as a context variable named queryset. type: string url: format: uri readOnly: true type: string required: - content_type - created - display - id - last_updated - name - notes_url - owner - template_code - url type: object ExportTemplateRequest: description: Extend ValidatedModelSerializer with a `relationships` field. properties: content_type: type: string description: maxLength: 200 type: string file_extension: description: Extension to append to the rendered filename maxLength: 15 type: string mime_type: description: Defaults to text/plain maxLength: 50 type: string name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object template_code: description: The list of objects being exported is passed as a context variable named queryset. minLength: 1 type: string required: - content_type - name - template_code type: object FQDN: description: FQDN Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_addresses: items: properties: address: type: string display: description: Human friendly display value readOnly: true type: string family: readOnly: true type: integer id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - address - display - family - id - url type: object type: array last_updated: format: date-time nullable: true readOnly: true type: string name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object FaceEnum: enum: - front - rear type: string FailoverStrategyEnum: enum: - active-active - active-passive type: string FeedLegEnum: enum: - A - B - C type: string FilterLogicEnum: enum: - disabled - loose - exact type: string FrontPort: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string rear_port: $ref: '#/components/schemas/FrontPortRearPort' rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - 8P8C - 8P6C - 8P4C - 8P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - MRJ21 - FC - LC - LC/APC - LSH - LSH/APC - MPO - MTRJ - SC - SC/APC - ST - CS - SN - URM-P2 - URM-P4 - URM-P8 - Splice type: string value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - mrj21 - fc - lc - lc-apc - lsh - lsh-apc - mpo - mtrj - sc - sc-apc - st - cs - sn - urm-p2 - urm-p4 - urm-p8 - splice type: string type: object url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - created - device - display - id - last_updated - name - notes_url - rear_port - type - url type: object FrontPortRearPort: description: NestedRearPortSerializer but with parent device omitted (since front and rear ports must belong to same device) properties: created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - url type: object FrontPortRearPortRequest: description: NestedRearPortSerializer but with parent device omitted (since front and rear ports must belong to same device) properties: label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string required: - id type: object FrontPortTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string rear_port: $ref: '#/components/schemas/NestedRearPortTemplate' rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer type: properties: label: enum: - 8P8C - 8P6C - 8P4C - 8P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - MRJ21 - FC - LC - LC/APC - LSH - LSH/APC - MPO - MTRJ - SC - SC/APC - ST - CS - SN - URM-P2 - URM-P4 - URM-P8 - Splice type: string value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - mrj21 - fc - lc - lc-apc - lsh - lsh-apc - mpo - mtrj - sc - sc-apc - st - cs - sn - urm-p2 - urm-p4 - urm-p8 - splice type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - rear_port - type - url type: object GitRepository: description: Git repositories defined as a data source. properties: branch: maxLength: 64 type: string created: format: date nullable: true readOnly: true type: string current_head: description: Commit hash of the most recent fetch from the selected branch. Used for syncing between workers. maxLength: 48 type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string provided_contents: items: oneOf: - $ref: '#/components/schemas/ProvidedContentsEnum' - $ref: '#/components/schemas/BlankEnum' type: array remote_url: description: Only HTTP and HTTPS URLs are presently supported format: uri maxLength: 255 type: string secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroup' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string username: maxLength: 64 type: string required: - created - display - id - last_updated - name - notes_url - remote_url - url type: object GitRepositoryRequest: description: Git repositories defined as a data source. properties: branch: maxLength: 64 minLength: 1 type: string current_head: description: Commit hash of the most recent fetch from the selected branch. Used for syncing between workers. maxLength: 48 type: string custom_fields: additionalProperties: {} type: object name: maxLength: 100 minLength: 1 type: string provided_contents: items: oneOf: - $ref: '#/components/schemas/ProvidedContentsEnum' - $ref: '#/components/schemas/BlankEnum' type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remote_url: description: Only HTTP and HTTPS URLs are presently supported format: uri maxLength: 255 minLength: 1 type: string secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroupRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string token: minLength: 1 type: string writeOnly: true username: maxLength: 64 type: string required: - name - remote_url type: object GoldenConfig: description: Serializer for GoldenConfig object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_config: description: Full backup config for device. type: string backup_last_attempt_date: format: date-time nullable: true type: string backup_last_success_date: format: date-time nullable: true type: string compliance_config: description: Full config diff for device. type: string compliance_last_attempt_date: format: date-time nullable: true type: string compliance_last_success_date: format: date-time nullable: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device: description: device format: uuid type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string intended_config: description: Intended config for the device. type: string intended_last_attempt_date: format: date-time nullable: true type: string intended_last_success_date: format: date-time nullable: true type: string last_updated: format: date-time nullable: true readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - device - display - id - last_updated - url type: object GoldenConfigRequest: description: Serializer for GoldenConfig object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_config: description: Full backup config for device. type: string backup_last_attempt_date: format: date-time nullable: true type: string backup_last_success_date: format: date-time nullable: true type: string compliance_config: description: Full config diff for device. type: string compliance_last_attempt_date: format: date-time nullable: true type: string compliance_last_success_date: format: date-time nullable: true type: string custom_fields: additionalProperties: {} type: object device: description: device format: uuid type: string intended_config: description: Intended config for the device. type: string intended_last_attempt_date: format: date-time nullable: true type: string intended_last_success_date: format: date-time nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device type: object GoldenConfigSetting: description: Serializer for GoldenConfigSetting object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_path_template: description: The Jinja path representation of where the backup file will be found. The variable `obj` is available as the device instance object of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Backup Path in Jinja Template Form type: string backup_repository: format: uuid nullable: true type: string backup_test_connectivity: description: Whether or not to pretest the connectivity of the device by verifying there is a resolvable IP that can connect to port 22. title: Backup Test type: boolean created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string dynamic_group: $ref: '#/components/schemas/NestedDynamicGroup' id: format: uuid readOnly: true type: string intended_path_template: description: The Jinja path representation of where the generated file will be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Intended Path in Jinja Template Form type: string intended_repository: format: uuid nullable: true type: string jinja_path_template: description: The Jinja path representation of where the Jinja template can be found. e.g. `{{obj.platform.slug}}.j2` maxLength: 255 title: Template Path in Jinja Template Form type: string jinja_repository: format: uuid nullable: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string scope: additionalProperties: {} type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string sot_agg_query: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string weight: maximum: 32767 minimum: 0 type: integer required: - created - display - id - last_updated - name - slug - url type: object GrantTypeEnum: enum: - organization - channel - user type: string GraphQLAPIRequest: properties: query: description: GraphQL query minLength: 1 type: string variables: additionalProperties: {} description: Variables in JSON Format type: object required: - query type: object GraphQLQuery: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string query: type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string variables: additionalProperties: {} default: {} nullable: true type: object required: - created - display - id - last_updated - name - notes_url - query - url type: object GraphQLQueryInputRequest: properties: variables: additionalProperties: {} default: {} nullable: true type: object type: object GraphQLQueryOutput: properties: data: additionalProperties: {} default: {} type: object type: object GraphQLQueryRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: name: maxLength: 100 minLength: 1 type: string query: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string variables: additionalProperties: {} default: {} nullable: true type: object required: - name - query type: object Group: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: display: description: Human friendly display value readOnly: true type: string id: readOnly: true type: integer name: maxLength: 150 type: string url: format: uri readOnly: true type: string user_count: readOnly: true type: integer required: - display - id - name - url - user_count type: object GroupRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: name: maxLength: 150 minLength: 1 type: string required: - name type: object HardwareLCM: description: API serializer. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_type: allOf: - $ref: '#/components/schemas/NestedDeviceType' description: Device Type to attach the Hardware LCM to devices: description: Devices tied to Device Type items: $ref: '#/components/schemas/NestedDevice' readOnly: true type: array display: description: Human friendly display value readOnly: true type: string documentation_url: format: uri maxLength: 200 type: string end_of_sale: format: date nullable: true type: string end_of_security_patches: format: date nullable: true type: string end_of_support: format: date nullable: true type: string end_of_sw_releases: format: date nullable: true title: End of Software Releases type: string expired: readOnly: true type: string id: format: uuid readOnly: true type: string inventory_item: maxLength: 255 nullable: true title: Inventory Item Part type: string last_updated: format: date-time nullable: true readOnly: true type: string release_date: format: date nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - device_type - devices - display - expired - id - last_updated - url type: object HttpMethodEnum: enum: - GET - POST - PUT - PATCH - DELETE type: string IPAddress: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: address: type: string assigned_object: additionalProperties: {} nullable: true readOnly: true type: object assigned_object_id: format: uuid nullable: true type: string assigned_object_type: nullable: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string dns_name: description: Hostname or FQDN (not case-sensitive) maxLength: 255 pattern: ^[0-9A-Za-z._-]+$ type: string family: properties: label: enum: - IPv4 - IPv6 type: string value: enum: - 4 - 6 type: integer readOnly: true type: object id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string nat_inside: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true nat_outside: items: $ref: '#/components/schemas/NestedIPAddress' readOnly: true type: array notes_url: format: uri readOnly: true type: string role: properties: label: enum: - Loopback - Secondary - Anycast - VIP - VRRP - HSRP - GLBP - CARP type: string value: enum: - loopback - secondary - anycast - vip - vrrp - hsrp - glbp - carp type: string type: object status: properties: label: enum: - Active - Deprecated - DHCP - Reserved - SLAAC type: string value: enum: - active - deprecated - dhcp - reserved - slaac type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vrf: allOf: - $ref: '#/components/schemas/NestedVRF' nullable: true required: - address - assigned_object - created - display - family - id - last_updated - nat_outside - notes_url - status - url type: object IPAddressStatusChoices: enum: - active - deprecated - dhcp - reserved - slaac type: string IPRange: description: IPRange Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string end_address: type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string notes_url: format: uri readOnly: true type: string size: readOnly: true type: integer start_address: type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string vrf: format: uuid nullable: true type: string required: - created - display - end_address - id - last_updated - notes_url - size - start_address - url type: object IPRangeRequest: description: IPRange Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string end_address: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start_address: minLength: 1 type: string status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array vrf: format: uuid nullable: true type: string required: - end_address - start_address type: object ImageAttachment: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string created: format: date-time readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string image: format: uri type: string image_height: maximum: 32767 minimum: 0 type: integer image_width: maximum: 32767 minimum: 0 type: integer name: maxLength: 50 type: string object_id: format: uuid type: string parent: additionalProperties: {} readOnly: true type: object url: format: uri readOnly: true type: string required: - content_type - created - display - id - image - image_height - image_width - object_id - parent - url type: object ImageAttachmentRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string image: format: binary type: string image_height: maximum: 32767 minimum: 0 type: integer image_width: maximum: 32767 minimum: 0 type: integer name: maxLength: 50 type: string object_id: format: uuid type: string required: - content_type - image - image_height - image_width - object_id type: object ImpactEnum: enum: - NO-IMPACT - REDUCED-REDUNDANCY - DEGRADED - OUTAGE type: string Interface: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string count_ipaddresses: readOnly: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string enabled: type: boolean id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string lag: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true last_updated: format: date-time nullable: true readOnly: true type: string mac_address: maxLength: 18 nullable: true type: string mgmt_only: description: This interface is used only for out-of-band management title: Management only type: boolean mode: properties: label: enum: - Access - Tagged - Tagged (All) type: string value: enum: - access - tagged - tagged-all type: string type: object mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true status: properties: label: enum: - Active - Decommissioning - Failed - Maintenance - Planned type: string value: enum: - active - decommissioning - failed - maintenance - planned type: string type: object tagged_vlans: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - display - id - name - url - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - Virtual - Bridge - Link Aggregation Group (LAG) - 100BASE-TX (10/100ME) - 1000BASE-T (1GE) - 2.5GBASE-T (2.5GE) - 5GBASE-T (5GE) - 10GBASE-T (10GE) - 10GBASE-CX4 (10GE) - GBIC (1GE) - SFP (1GE) - SFP+ (10GE) - XFP (10GE) - XENPAK (10GE) - X2 (10GE) - SFP28 (25GE) - QSFP+ (40GE) - QSFP28 (50GE) - CFP (100GE) - CFP2 (100GE) - CFP2 (200GE) - CFP4 (100GE) - Cisco CPAK (100GE) - QSFP28 (100GE) - QSFP56 (200GE) - QSFP-DD (400GE) - OSFP (400GE) - IEEE 802.11a - IEEE 802.11b/g - IEEE 802.11n - IEEE 802.11ac - IEEE 802.11ad - IEEE 802.11ax - GSM - CDMA - LTE - OC-3/STM-1 - OC-12/STM-4 - OC-48/STM-16 - OC-192/STM-64 - OC-768/STM-256 - OC-1920/STM-640 - OC-3840/STM-1234 - SFP (1GFC) - SFP (2GFC) - SFP (4GFC) - SFP+ (8GFC) - SFP+ (16GFC) - SFP28 (32GFC) - QSFP+ (64GFC) - QSFP28 (128GFC) - SDR (2 Gbps) - DDR (4 Gbps) - QDR (8 Gbps) - FDR10 (10 Gbps) - FDR (13.5 Gbps) - EDR (25 Gbps) - HDR (50 Gbps) - NDR (100 Gbps) - XDR (250 Gbps) - T1 (1.544 Mbps) - E1 (2.048 Mbps) - T3 (45 Mbps) - E3 (34 Mbps) - Cisco StackWise - Cisco StackWise Plus - Cisco FlexStack - Cisco FlexStack Plus - Juniper VCP - Extreme SummitStack - Extreme SummitStack-128 - Extreme SummitStack-256 - Extreme SummitStack-512 - Other type: string value: enum: - virtual - bridge - lag - 100base-tx - 1000base-t - 2.5gbase-t - 5gbase-t - 10gbase-t - 10gbase-cx4 - 1000base-x-gbic - 1000base-x-sfp - 10gbase-x-sfpp - 10gbase-x-xfp - 10gbase-x-xenpak - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 100gbase-x-cfp - 100gbase-x-cfp2 - 200gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cpak - 100gbase-x-qsfp28 - 200gbase-x-qsfp56 - 400gbase-x-qsfpdd - 400gbase-x-osfp - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - gsm - cdma - lte - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 64gfc-qsfpp - 128gfc-sfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string type: object untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLAN' nullable: true url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - count_ipaddresses - created - device - display - id - last_updated - name - notes_url - status - type - url type: object InterfaceConnection: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: connected_endpoint_reachable: nullable: true readOnly: true type: boolean created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string interface_a: allOf: - $ref: '#/components/schemas/NestedInterface' readOnly: true interface_b: $ref: '#/components/schemas/NestedInterface' last_updated: format: date-time nullable: true readOnly: true type: string required: - connected_endpoint_reachable - created - display - id - interface_a - interface_b - last_updated type: object InterfaceSerializerVersion12: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string count_ipaddresses: readOnly: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string enabled: type: boolean id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string lag: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true last_updated: format: date-time nullable: true readOnly: true type: string mac_address: maxLength: 18 nullable: true type: string mgmt_only: description: This interface is used only for out-of-band management title: Management only type: boolean mode: properties: label: enum: - Access - Tagged - Tagged (All) type: string value: enum: - access - tagged - tagged-all type: string type: object mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true tagged_vlans: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - display - id - name - url - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - Virtual - Bridge - Link Aggregation Group (LAG) - 100BASE-TX (10/100ME) - 1000BASE-T (1GE) - 2.5GBASE-T (2.5GE) - 5GBASE-T (5GE) - 10GBASE-T (10GE) - 10GBASE-CX4 (10GE) - GBIC (1GE) - SFP (1GE) - SFP+ (10GE) - XFP (10GE) - XENPAK (10GE) - X2 (10GE) - SFP28 (25GE) - QSFP+ (40GE) - QSFP28 (50GE) - CFP (100GE) - CFP2 (100GE) - CFP2 (200GE) - CFP4 (100GE) - Cisco CPAK (100GE) - QSFP28 (100GE) - QSFP56 (200GE) - QSFP-DD (400GE) - OSFP (400GE) - IEEE 802.11a - IEEE 802.11b/g - IEEE 802.11n - IEEE 802.11ac - IEEE 802.11ad - IEEE 802.11ax - GSM - CDMA - LTE - OC-3/STM-1 - OC-12/STM-4 - OC-48/STM-16 - OC-192/STM-64 - OC-768/STM-256 - OC-1920/STM-640 - OC-3840/STM-1234 - SFP (1GFC) - SFP (2GFC) - SFP (4GFC) - SFP+ (8GFC) - SFP+ (16GFC) - SFP28 (32GFC) - QSFP+ (64GFC) - QSFP28 (128GFC) - SDR (2 Gbps) - DDR (4 Gbps) - QDR (8 Gbps) - FDR10 (10 Gbps) - FDR (13.5 Gbps) - EDR (25 Gbps) - HDR (50 Gbps) - NDR (100 Gbps) - XDR (250 Gbps) - T1 (1.544 Mbps) - E1 (2.048 Mbps) - T3 (45 Mbps) - E3 (34 Mbps) - Cisco StackWise - Cisco StackWise Plus - Cisco FlexStack - Cisco FlexStack Plus - Juniper VCP - Extreme SummitStack - Extreme SummitStack-128 - Extreme SummitStack-256 - Extreme SummitStack-512 - Other type: string value: enum: - virtual - bridge - lag - 100base-tx - 1000base-t - 2.5gbase-t - 5gbase-t - 10gbase-t - 10gbase-cx4 - 1000base-x-gbic - 1000base-x-sfp - 10gbase-x-sfpp - 10gbase-x-xfp - 10gbase-x-xenpak - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 100gbase-x-cfp - 100gbase-x-cfp2 - 200gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cpak - 100gbase-x-qsfp28 - 200gbase-x-qsfp56 - 400gbase-x-qsfpdd - 400gbase-x-osfp - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - gsm - cdma - lte - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 64gfc-qsfpp - 128gfc-sfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string type: object untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLAN' nullable: true url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - count_ipaddresses - created - device - display - id - last_updated - name - notes_url - type - url type: object InterfaceStatusChoices: enum: - active - decommissioning - failed - maintenance - planned type: string InterfaceTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string mgmt_only: title: Management only type: boolean name: maxLength: 64 type: string type: properties: label: enum: - Virtual - Bridge - Link Aggregation Group (LAG) - 100BASE-TX (10/100ME) - 1000BASE-T (1GE) - 2.5GBASE-T (2.5GE) - 5GBASE-T (5GE) - 10GBASE-T (10GE) - 10GBASE-CX4 (10GE) - GBIC (1GE) - SFP (1GE) - SFP+ (10GE) - XFP (10GE) - XENPAK (10GE) - X2 (10GE) - SFP28 (25GE) - QSFP+ (40GE) - QSFP28 (50GE) - CFP (100GE) - CFP2 (100GE) - CFP2 (200GE) - CFP4 (100GE) - Cisco CPAK (100GE) - QSFP28 (100GE) - QSFP56 (200GE) - QSFP-DD (400GE) - OSFP (400GE) - IEEE 802.11a - IEEE 802.11b/g - IEEE 802.11n - IEEE 802.11ac - IEEE 802.11ad - IEEE 802.11ax - GSM - CDMA - LTE - OC-3/STM-1 - OC-12/STM-4 - OC-48/STM-16 - OC-192/STM-64 - OC-768/STM-256 - OC-1920/STM-640 - OC-3840/STM-1234 - SFP (1GFC) - SFP (2GFC) - SFP (4GFC) - SFP+ (8GFC) - SFP+ (16GFC) - SFP28 (32GFC) - QSFP+ (64GFC) - QSFP28 (128GFC) - SDR (2 Gbps) - DDR (4 Gbps) - QDR (8 Gbps) - FDR10 (10 Gbps) - FDR (13.5 Gbps) - EDR (25 Gbps) - HDR (50 Gbps) - NDR (100 Gbps) - XDR (250 Gbps) - T1 (1.544 Mbps) - E1 (2.048 Mbps) - T3 (45 Mbps) - E3 (34 Mbps) - Cisco StackWise - Cisco StackWise Plus - Cisco FlexStack - Cisco FlexStack Plus - Juniper VCP - Extreme SummitStack - Extreme SummitStack-128 - Extreme SummitStack-256 - Extreme SummitStack-512 - Other type: string value: enum: - virtual - bridge - lag - 100base-tx - 1000base-t - 2.5gbase-t - 5gbase-t - 10gbase-t - 10gbase-cx4 - 1000base-x-gbic - 1000base-x-sfp - 10gbase-x-sfpp - 10gbase-x-xfp - 10gbase-x-xenpak - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 100gbase-x-cfp - 100gbase-x-cfp2 - 200gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cpak - 100gbase-x-qsfp28 - 200gbase-x-qsfp56 - 400gbase-x-qsfpdd - 400gbase-x-osfp - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - gsm - cdma - lte - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 64gfc-qsfpp - 128gfc-sfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - type - url type: object InterfaceTypeChoices: enum: - virtual - bridge - lag - 100base-tx - 1000base-t - 2.5gbase-t - 5gbase-t - 10gbase-t - 10gbase-cx4 - 1000base-x-gbic - 1000base-x-sfp - 10gbase-x-sfpp - 10gbase-x-xfp - 10gbase-x-xenpak - 10gbase-x-x2 - 25gbase-x-sfp28 - 40gbase-x-qsfpp - 50gbase-x-sfp28 - 100gbase-x-cfp - 100gbase-x-cfp2 - 200gbase-x-cfp2 - 100gbase-x-cfp4 - 100gbase-x-cpak - 100gbase-x-qsfp28 - 200gbase-x-qsfp56 - 400gbase-x-qsfpdd - 400gbase-x-osfp - ieee802.11a - ieee802.11g - ieee802.11n - ieee802.11ac - ieee802.11ad - ieee802.11ax - gsm - cdma - lte - sonet-oc3 - sonet-oc12 - sonet-oc48 - sonet-oc192 - sonet-oc768 - sonet-oc1920 - sonet-oc3840 - 1gfc-sfp - 2gfc-sfp - 4gfc-sfp - 8gfc-sfpp - 16gfc-sfpp - 32gfc-sfp28 - 64gfc-qsfpp - 128gfc-sfp28 - infiniband-sdr - infiniband-ddr - infiniband-qdr - infiniband-fdr10 - infiniband-fdr - infiniband-edr - infiniband-hdr - infiniband-ndr - infiniband-xdr - t1 - e1 - t3 - e3 - cisco-stackwise - cisco-stackwise-plus - cisco-flexstack - cisco-flexstack-plus - juniper-vcp - extreme-summitstack - extreme-summitstack-128 - extreme-summitstack-256 - extreme-summitstack-512 - other type: string InventoryItem: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: _depth: readOnly: true title: ' depth' type: integer asset_tag: description: A unique tag used to identify this item maxLength: 50 nullable: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' discovered: description: This item was automatically discovered type: boolean display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturer' nullable: true name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string parent: format: uuid nullable: true type: string part_id: description: Manufacturer-assigned part identifier maxLength: 50 type: string serial: maxLength: 255 title: Serial number type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - _depth - created - device - display - id - last_updated - name - notes_url - url type: object IpProtocolEnum: enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string Job: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: approval_required: description: Whether the job requires approval from another user before running type: boolean approval_required_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean commit_default: description: Whether the job defaults to committing changes when run, or defaults to a dry-run type: boolean commit_default_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: description: Markdown formatting is supported type: string description_override: description: If set, the configured description will remain even if the underlying Job source code changes type: boolean display: description: Human friendly display value readOnly: true type: string enabled: description: Whether this job can be executed by users type: boolean grouping: description: Human-readable grouping that this job belongs to maxLength: 255 type: string grouping_override: description: If set, the configured grouping will remain even if the underlying Job source code changes type: boolean has_sensitive_variables: description: Whether this job contains sensitive variables type: boolean has_sensitive_variables_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean hidden: description: Whether the job defaults to not being shown in the UI type: boolean hidden_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean id: format: uuid readOnly: true type: string installed: description: Whether the Python module and class providing this job are presently installed and loadable readOnly: true type: boolean is_job_hook_receiver: description: Whether this job is a job hook receiver readOnly: true type: boolean job_class_name: description: Name of the Python class providing this job readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string module_name: description: Dotted name of the Python module providing this job readOnly: true type: string name: description: Human-readable name of this job maxLength: 100 type: string name_override: description: If set, the configured name will remain even if the underlying Job source code changes type: boolean notes_url: format: uri readOnly: true type: string read_only: description: Whether the job is prevented from making lasting changes to the database type: boolean read_only_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean slug: maxLength: 320 pattern: ^[-a-zA-Z0-9_]+$ type: string soft_time_limit: description: Maximum runtime in seconds before the job will receive a SoftTimeLimitExceeded exception.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number soft_time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean source: description: Source of the Python code for this job - local, Git repository, or plugins readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array task_queues: additionalProperties: {} description: Comma separated list of task queues that this job can run on. A blank list will use the default queue type: object task_queues_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean time_limit: description: Maximum runtime in seconds before the job will be forcibly terminated.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean url: format: uri readOnly: true type: string required: - created - display - grouping - id - installed - is_job_hook_receiver - job_class_name - last_updated - module_name - name - notes_url - source - url type: object JobClassDetail: properties: description: maxLength: 255 readOnly: true type: string id: readOnly: true type: string name: maxLength: 255 readOnly: true type: string pk: format: uuid nullable: true readOnly: true type: string result: $ref: '#/components/schemas/JobResult' test_methods: items: maxLength: 255 type: string type: array url: format: uri readOnly: true type: string vars: additionalProperties: {} readOnly: true type: object required: - description - id - name - pk - test_methods - url - vars type: object JobExecutionTypeIntervalChoices: enum: - immediately - future - hourly - daily - weekly - custom type: string JobHook: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string enabled: type: boolean id: format: uuid readOnly: true type: string job: description: The job that this job hook will initiate format: uuid type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string type_create: description: Call this job hook when a matching object is created. type: boolean type_delete: description: Call this job hook when a matching object is deleted. type: boolean type_update: description: Call this job hook when a matching object is updated. type: boolean url: format: uri readOnly: true type: string required: - content_types - created - display - id - job - last_updated - name - notes_url - url type: object JobHookRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object enabled: type: boolean job: description: The job that this job hook will initiate format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type_create: description: Call this job hook when a matching object is created. type: boolean type_delete: description: Call this job hook when a matching object is deleted. type: boolean type_update: description: Call this job hook when a matching object is updated. type: boolean required: - content_types - job - name type: object JobInputRequest: properties: commit: type: boolean data: additionalProperties: {} type: object schedule: $ref: '#/components/schemas/NestedScheduledJobRequest' task_queue: type: string type: object JobLogEntry: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: absolute_url: maxLength: 255 nullable: true type: string created: format: date-time type: string display: readOnly: true type: string grouping: maxLength: 100 type: string id: format: uuid readOnly: true type: string job_result: format: uuid type: string log_level: $ref: '#/components/schemas/LogLevelEnum' log_object: maxLength: 200 nullable: true type: string message: type: string url: format: uri readOnly: true type: string required: - display - id - job_result - url type: object JobMultiPartInputRequest: description: JobMultiPartInputSerializer is a "flattened" version of JobInputSerializer for use with multipart/form-data submissions which only accept key-value pairs properties: _commit: title: ' commit' type: boolean _schedule_crontab: title: ' schedule crontab' type: string _schedule_interval: allOf: - $ref: '#/components/schemas/JobExecutionTypeIntervalChoices' title: ' schedule interval' _schedule_name: maxLength: 255 minLength: 1 title: ' schedule name' type: string _schedule_start_time: format: date-time title: ' schedule start time' type: string _task_queue: title: ' task queue' type: string type: object JobRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: approval_required: description: Whether the job requires approval from another user before running type: boolean approval_required_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean commit_default: description: Whether the job defaults to committing changes when run, or defaults to a dry-run type: boolean commit_default_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean custom_fields: additionalProperties: {} type: object description: description: Markdown formatting is supported type: string description_override: description: If set, the configured description will remain even if the underlying Job source code changes type: boolean enabled: description: Whether this job can be executed by users type: boolean grouping: description: Human-readable grouping that this job belongs to maxLength: 255 minLength: 1 type: string grouping_override: description: If set, the configured grouping will remain even if the underlying Job source code changes type: boolean has_sensitive_variables: description: Whether this job contains sensitive variables type: boolean has_sensitive_variables_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean hidden: description: Whether the job defaults to not being shown in the UI type: boolean hidden_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean name: description: Human-readable name of this job maxLength: 100 minLength: 1 type: string name_override: description: If set, the configured name will remain even if the underlying Job source code changes type: boolean read_only: description: Whether the job is prevented from making lasting changes to the database type: boolean read_only_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 320 pattern: ^[-a-zA-Z0-9_]+$ type: string soft_time_limit: description: Maximum runtime in seconds before the job will receive a SoftTimeLimitExceeded exception.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number soft_time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array task_queues: additionalProperties: {} description: Comma separated list of task queues that this job can run on. A blank list will use the default queue type: object task_queues_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean time_limit: description: Maximum runtime in seconds before the job will be forcibly terminated.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean required: - grouping - name type: object JobResult: description: Extends ModelSerializer to render any CustomFields and their values associated with an object. properties: completed: format: date-time nullable: true type: string created: format: date-time readOnly: true type: string custom_fields: additionalProperties: {} type: object data: additionalProperties: {} nullable: true type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string job_id: format: uuid type: string job_kwargs: additionalProperties: {} nullable: true type: object job_model: allOf: - $ref: '#/components/schemas/NestedJob' readOnly: true name: maxLength: 255 type: string obj_type: readOnly: true type: string schedule: allOf: - $ref: '#/components/schemas/NestedScheduledJob' readOnly: true status: properties: label: enum: - Pending - Running - Completed - Errored - Failed type: string value: enum: - pending - running - completed - errored - failed type: string readOnly: true type: object url: format: uri readOnly: true type: string user: allOf: - $ref: '#/components/schemas/NestedUser' readOnly: true required: - created - display - id - job_id - job_model - name - obj_type - schedule - status - url - user type: object JobRunResponse: description: Serializer representing responses from the JobModelViewSet.run() POST endpoint. properties: job_result: allOf: - $ref: '#/components/schemas/NestedJobResult' readOnly: true schedule: allOf: - $ref: '#/components/schemas/NestedScheduledJob' readOnly: true required: - job_result - schedule type: object JobVariable: description: Serializer used for responses from the JobModelViewSet.variables() detail endpoint. properties: choices: additionalProperties: {} readOnly: true type: object default: additionalProperties: {} readOnly: true type: object help_text: readOnly: true type: string label: readOnly: true type: string max_length: readOnly: true type: integer max_value: readOnly: true type: integer min_length: readOnly: true type: integer min_value: readOnly: true type: integer model: readOnly: true type: string name: readOnly: true type: string required: readOnly: true type: boolean type: readOnly: true type: string required: - choices - default - help_text - label - max_length - max_value - min_length - min_value - model - name - required - type type: object LengthUnitEnum: enum: - m - cm - ft - in type: string Location: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location_type: $ref: '#/components/schemas/NestedLocationType' name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSite' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: properties: label: enum: - Active - Decommissioning - Planned - Retired - Staging type: string value: enum: - active - decommissioning - planned - retired - staging type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true tree_depth: nullable: true readOnly: true type: integer url: format: uri readOnly: true type: string required: - created - display - id - last_updated - location_type - name - notes_url - status - tree_depth - url type: object LocationStatusChoices: enum: - active - decommissioning - planned - retired - staging type: string LocationType: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string nestable: description: Allow Locations of this type to be parents/children of other Locations of this same type type: boolean notes_url: format: uri readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/NestedLocationType' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tree_depth: nullable: true readOnly: true type: integer url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - tree_depth - url type: object LogLevelEnum: enum: - default - success - info - warning - failure type: string Manufacturer: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string devicetype_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string inventoryitem_count: readOnly: true type: integer last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string platform_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - created - devicetype_count - display - id - inventoryitem_count - last_updated - name - notes_url - platform_count - url type: object ManufacturerRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object MinMaxValidationRule: description: Serializer for `MinMaxValidationRule` objects. properties: content_type: type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string max: description: When set, apply a maximum value contraint to the value of the model field. format: double nullable: true type: number min: description: When set, apply a minimum value contraint to the value of the model field. format: double nullable: true type: number name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - content_type - created - display - field - id - last_updated - name - slug - url type: object MinMaxValidationRuleRequest: description: Serializer for `MinMaxValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string max: description: When set, apply a maximum value contraint to the value of the model field. format: double nullable: true type: number min: description: When set, apply a minimum value contraint to the value of the model field. format: double nullable: true type: number name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_type - field - name - slug type: object ModeEnum: enum: - access - tagged - tagged-all type: string NATPolicy: description: NATPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/NATPolicyDeviceM2MNested' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNested' type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string nat_policy_rules: items: format: uuid type: string readOnly: true type: array notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: format: uuid nullable: true type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - nat_policy_rules - notes_url - url type: object NATPolicyDeviceM2MNested: description: NATPolicyDeviceM2M NestedSerializer. properties: device: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - device type: object NATPolicyDeviceM2MNestedRequest: description: NATPolicyDeviceM2M NestedSerializer. properties: device: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object NATPolicyDynamicGroupM2MNested: description: NATPolicyDynamicGroupM2M NestedSerializer. properties: dynamic_group: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - dynamic_group type: object NATPolicyDynamicGroupM2MNestedRequest: description: NATPolicyDynamicGroupM2M NestedSerializer. properties: dynamic_group: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object NATPolicyRequest: description: NATPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - name type: object NATPolicyRule: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/Zone' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string index: maximum: 32767 minimum: 0 nullable: true type: integer last_updated: format: date-time nullable: true readOnly: true type: string log: type: boolean name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string original_destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array original_destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array original_destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array original_destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array original_source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array original_source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array original_source_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array original_source_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array remark: type: boolean request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/Zone' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array translated_destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array translated_destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array translated_destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array translated_destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array translated_source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array translated_source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array translated_source_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array translated_source_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object NestedAutonomousSystem: description: Nested/brief serializer for AutonomousSystem. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - asn - display - id - url type: object NestedAutonomousSystemRequest: description: Nested/brief serializer for AutonomousSystem. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer required: - id type: object NestedCVELCM: description: Nested serializer for the CVE class. properties: comments: type: string cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string display: description: Human friendly display value readOnly: true type: string fix: maxLength: 255 nullable: true type: string id: format: uuid readOnly: true type: string link: format: uri maxLength: 200 type: string name: maxLength: 16 type: string published_date: format: date type: string severity: $ref: '#/components/schemas/SeverityEnum' status: format: uuid nullable: true type: string url: format: uri readOnly: true type: string required: - display - id - link - name - published_date - url type: object NestedCVELCMRequest: description: Nested serializer for the CVE class. properties: comments: type: string cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string fix: maxLength: 255 nullable: true type: string link: format: uri maxLength: 200 minLength: 1 type: string name: maxLength: 16 minLength: 1 type: string published_date: format: date type: string severity: $ref: '#/components/schemas/SeverityEnum' status: format: uuid nullable: true type: string required: - id type: object NestedCable: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: maxLength: 100 type: string url: format: uri readOnly: true type: string required: - display - id - url type: object NestedCableRequest: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: label: maxLength: 100 type: string required: - id type: object NestedCircuit: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cid: maxLength: 100 title: Circuit ID type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - cid - display - id - url type: object NestedCircuitRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cid: maxLength: 100 minLength: 1 title: Circuit ID type: string required: - id type: object NestedCircuitType: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: circuit_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - circuit_count - display - id - name - url type: object NestedCircuitTypeRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedCluster: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - display - id - name - url - virtualmachine_count type: object NestedClusterGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cluster_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - cluster_count - display - id - name - url type: object NestedClusterGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedClusterRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string required: - id type: object NestedClusterType: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cluster_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - cluster_count - display - id - name - url type: object NestedClusterTypeRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedConfigContextSchema: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 200 type: string slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedConfigContextSchemaRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 200 minLength: 1 type: string slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedContractLCM: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string display: description: Human friendly display value readOnly: true type: string end: format: date nullable: true title: Contract End Date type: string expired: readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderLCM' description: Contract Provider start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string required: - display - expired - id - name - provider type: object NestedContractLCMRequest: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string end: format: date nullable: true title: Contract End Date type: string name: maxLength: 100 minLength: 1 type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderLCMRequest' description: Contract Provider start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string required: - id type: object NestedCustomField: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: description: Human-readable unique name of this field. maxLength: 50 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedCustomFieldRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: description: Human-readable unique name of this field. maxLength: 50 minLength: 1 type: string required: - id type: object NestedDevice: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 nullable: true type: string url: format: uri readOnly: true type: string required: - display - id - url type: object NestedDeviceRedundancyGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string failover_strategy: oneOf: - $ref: '#/components/schemas/FailoverStrategyEnum' - $ref: '#/components/schemas/BlankEnum' id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedDeviceRedundancyGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: failover_strategy: oneOf: - $ref: '#/components/schemas/FailoverStrategyEnum' - $ref: '#/components/schemas/BlankEnum' name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedDeviceRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 nullable: true type: string required: - id type: object NestedDeviceRole: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - device_count - display - id - name - url - virtualmachine_count type: object NestedDeviceRoleRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedDeviceType: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturer' readOnly: true model: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - device_count - display - id - manufacturer - model - slug - url type: object NestedDeviceTypeRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: model: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedDynamicGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: content_type: type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: description: Dynamic Group name maxLength: 100 type: string slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - content_type - display - id - name - url type: object NestedDynamicGroupMembership: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string group: $ref: '#/components/schemas/NestedDynamicGroup' id: format: uuid readOnly: true type: string operator: $ref: '#/components/schemas/OperatorEnum' parent_group: $ref: '#/components/schemas/NestedDynamicGroup' url: format: uri readOnly: true type: string weight: maximum: 32767 minimum: 0 type: integer required: - display - group - id - operator - parent_group - url - weight type: object NestedDynamicGroupMembershipRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: group: $ref: '#/components/schemas/NestedDynamicGroupRequest' operator: $ref: '#/components/schemas/OperatorEnum' parent_group: $ref: '#/components/schemas/NestedDynamicGroupRequest' weight: maximum: 32767 minimum: 0 type: integer required: - id type: object NestedDynamicGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: content_type: type: string name: description: Dynamic Group name maxLength: 100 minLength: 1 type: string slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedFQDN: description: Nested serializer for FQDN. properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedFQDNRequest: description: Nested serializer for FQDN. properties: name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 minLength: 1 type: string required: - id type: object NestedIPAddress: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: address: type: string display: description: Human friendly display value readOnly: true type: string family: readOnly: true type: integer id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - address - display - family - id - url type: object NestedIPAddressRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: address: minLength: 1 type: string required: - id type: object NestedIPRange: description: Nested serializer for IPRange. properties: display: description: Human friendly display value readOnly: true type: string end_address: type: string id: format: uuid readOnly: true type: string start_address: type: string url: format: uri readOnly: true type: string required: - display - end_address - id - start_address - url type: object NestedIPRangeRequest: description: Nested serializer for IPRange. properties: end_address: minLength: 1 type: string start_address: minLength: 1 type: string required: - id type: object NestedInterface: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cable: format: uuid nullable: true type: string device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - device - display - id - name - url type: object NestedInterfaceRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cable: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedInventoryItem: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: _depth: readOnly: true title: ' depth' type: integer device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - _depth - device - display - id - name - url type: object NestedInventoryItemRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedJob: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: display: description: Human friendly display value readOnly: true type: string grouping: description: Human-readable grouping that this job belongs to maxLength: 255 type: string id: format: uuid readOnly: true type: string job_class_name: description: Name of the Python class providing this job readOnly: true type: string module_name: description: Dotted name of the Python module providing this job readOnly: true type: string name: description: Human-readable name of this job maxLength: 100 type: string slug: maxLength: 320 pattern: ^[-a-zA-Z0-9_]+$ type: string source: description: Source of the Python code for this job - local, Git repository, or plugins readOnly: true type: string url: format: uri readOnly: true type: string required: - display - grouping - id - job_class_name - module_name - name - source - url type: object NestedJobResult: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: completed: format: date-time nullable: true type: string created: format: date-time readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 255 type: string status: properties: label: enum: - Pending - Running - Completed - Errored - Failed type: string value: enum: - pending - running - completed - errored - failed type: string type: object url: format: uri readOnly: true type: string user: allOf: - $ref: '#/components/schemas/NestedUser' readOnly: true required: - created - display - id - name - status - url - user type: object NestedLocation: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tree_depth: nullable: true readOnly: true type: integer url: format: uri readOnly: true type: string required: - display - id - name - tree_depth - url type: object NestedLocationRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedLocationType: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tree_depth: nullable: true readOnly: true type: integer url: format: uri readOnly: true type: string required: - display - id - name - tree_depth - url type: object NestedLocationTypeRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedManufacturer: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: devicetype_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - devicetype_count - display - id - name - url type: object NestedManufacturerRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedPeerEndpoint: description: Nested/brief serializer for PeerEndpoint. properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - display - id - url type: object NestedPeerGroup: description: Nested/brief serializer for PeerGroup. properties: display: description: Human friendly display value readOnly: true type: string enabled: type: boolean id: format: uuid readOnly: true type: string name: maxLength: 100 type: string role: format: uuid nullable: true type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedPeerGroupRequest: description: Nested/brief serializer for PeerGroup. properties: enabled: type: boolean name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string required: - id type: object NestedPeerGroupTemplate: description: Nested/brief serializer for PeerGroup. properties: display: description: Human friendly display value readOnly: true type: string enabled: type: boolean id: format: uuid readOnly: true type: string name: maxLength: 100 type: string role: format: uuid nullable: true type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedPeerGroupTemplateRequest: description: Nested/brief serializer for PeerGroup. properties: enabled: type: boolean name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string required: - id type: object NestedPeering: description: Nested/brief serializer for Peering. properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string status: format: uuid nullable: true type: string url: format: uri readOnly: true type: string required: - display - id - url type: object NestedPeeringRequest: description: Nested/brief serializer for Peering. properties: status: format: uuid nullable: true type: string required: - id type: object NestedPlatform: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - device_count - display - id - name - url - virtualmachine_count type: object NestedPlatformRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedPowerPanel: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string powerfeed_count: readOnly: true type: integer url: format: uri readOnly: true type: string required: - display - id - name - powerfeed_count - url type: object NestedPowerPanelRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string required: - id type: object NestedPowerPort: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cable: format: uuid nullable: true type: string device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - device - display - id - name - url type: object NestedPowerPortRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: cable: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedPowerPortTemplate: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedPowerPortTemplateRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedPrefix: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string family: readOnly: true type: integer id: format: uuid readOnly: true type: string prefix: type: string url: format: uri readOnly: true type: string required: - display - family - id - prefix - url type: object NestedPrefixRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: prefix: minLength: 1 type: string required: - id type: object NestedProvider: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: circuit_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - circuit_count - display - id - name - url type: object NestedProviderLCM: description: Nested serializer for the provider class. properties: comments: type: string description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string email: format: email maxLength: 254 title: E-mail type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string required: - display - id - name type: object NestedProviderLCMRequest: description: Nested serializer for the provider class. properties: comments: type: string description: maxLength: 200 type: string email: format: email maxLength: 254 title: E-mail type: string name: maxLength: 100 minLength: 1 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string required: - id type: object NestedProviderNetwork: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedProviderNetworkRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedProviderRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRIR: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: aggregate_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - aggregate_count - display - id - name - url type: object NestedRIRRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRack: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string url: format: uri readOnly: true type: string required: - device_count - display - id - name - url type: object NestedRackGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: _depth: readOnly: true title: ' depth' type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string rack_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - _depth - display - id - name - rack_count - url type: object NestedRackGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRackRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string required: - id type: object NestedRackRole: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string rack_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - rack_count - url type: object NestedRackRoleRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRearPortTemplate: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedRearPortTemplateRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedRegion: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: _depth: readOnly: true title: ' depth' type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string site_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - _depth - display - id - name - site_count - url type: object NestedRegionRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRelationship: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: description: Name of the relationship as displayed to users maxLength: 100 type: string slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedRelationshipRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: description: Name of the relationship as displayed to users maxLength: 100 minLength: 1 type: string slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRole: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string prefix_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string vlan_count: readOnly: true type: integer required: - display - id - name - prefix_count - url - vlan_count type: object NestedRoleRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedRoutingInstance: description: Nested/brief serializer for PeerEndpoint. properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - display - id - url type: object NestedScheduledJob: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: crontab: description: Cronjob syntax string for custom scheduling maxLength: 255 title: Custom cronjob type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string interval: $ref: '#/components/schemas/JobExecutionTypeIntervalChoices' name: maxLength: 255 type: string start_time: format: date-time type: string url: format: uri readOnly: true type: string required: - display - id - interval - url type: object NestedScheduledJobRequest: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: crontab: description: Cronjob syntax string for custom scheduling maxLength: 255 title: Custom cronjob type: string interval: $ref: '#/components/schemas/JobExecutionTypeIntervalChoices' name: maxLength: 255 minLength: 1 type: string start_time: format: date-time type: string required: - interval type: object NestedSecret: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedSecretRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedSecretsGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedSecretsGroupAssociation: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string secret: $ref: '#/components/schemas/NestedSecret' secret_type: $ref: '#/components/schemas/SecretTypeEnum' url: format: uri readOnly: true type: string required: - access_type - display - id - secret - secret_type - url type: object NestedSecretsGroupAssociationRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' secret: $ref: '#/components/schemas/NestedSecretRequest' secret_type: $ref: '#/components/schemas/SecretTypeEnum' required: - id type: object NestedSecretsGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedSite: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedSiteRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedSoftwareLCM: description: Nested/brief serializer for SoftwareLCM. properties: device_platform: format: uuid readOnly: true type: string display: description: Human friendly display value readOnly: true type: string end_of_support: format: date nullable: true title: End of Software Support type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string version: maxLength: 50 type: string required: - device_platform - display - id - url - version type: object NestedSoftwareLCMRequest: description: Nested/brief serializer for SoftwareLCM. properties: end_of_support: format: date nullable: true title: End of Software Support type: string version: maxLength: 50 minLength: 1 type: string required: - id type: object NestedTenant: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedTenantGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: _depth: readOnly: true title: ' depth' type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tenant_count: readOnly: true type: integer url: format: uri readOnly: true type: string required: - _depth - display - id - name - tenant_count - url type: object NestedTenantGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedTenantRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedUser: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 pattern: ^[\w.@+-]+$ type: string required: - display - id - url - username type: object NestedUserRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string required: - id type: object NestedVLAN: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - display - id - name - url - vid type: object NestedVLANGroup: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string vlan_count: readOnly: true type: integer required: - display - id - name - url - vlan_count type: object NestedVLANGroupRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object NestedVLANRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 minLength: 1 type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - id type: object NestedVMInterface: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string virtual_machine: allOf: - $ref: '#/components/schemas/NestedVirtualMachine' readOnly: true required: - display - id - name - url - virtual_machine type: object NestedVMInterfaceRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedVRF: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 100 type: string prefix_count: readOnly: true type: integer rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string url: format: uri readOnly: true type: string required: - display - id - name - prefix_count - url type: object NestedVRFRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 100 minLength: 1 type: string rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string required: - id type: object NestedVirtualChassis: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string master: $ref: '#/components/schemas/NestedDevice' member_count: readOnly: true type: integer name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - display - id - master - member_count - name - url type: object NestedVirtualChassisRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: master: $ref: '#/components/schemas/NestedDeviceRequest' name: maxLength: 64 minLength: 1 type: string required: - id type: object NestedVirtualMachine: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object NestedVirtualMachineRequest: description: 'Returns a nested representation of an object on read, but accepts either the nested representation or the primary key value on write operations.' properties: name: maxLength: 64 minLength: 1 type: string required: - id type: object Note: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: assigned_object: additionalProperties: {} nullable: true readOnly: true type: object assigned_object_id: format: uuid type: string assigned_object_type: type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string note: type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string user: allOf: - $ref: '#/components/schemas/NestedUser' readOnly: true user_name: readOnly: true type: string required: - assigned_object - assigned_object_id - assigned_object_type - created - display - id - last_updated - note - url - user - user_name type: object NoteInputRequest: properties: note: minLength: 1 type: string required: - note type: object NoteRequest: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: assigned_object_id: format: uuid type: string assigned_object_type: type: string note: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - assigned_object_id - assigned_object_type - note type: object NotificationSource: description: Serializer for NotificationSource records. properties: attach_all_providers: description: Attach all the Providers to this Notification Source type: boolean id: format: uuid readOnly: true type: string name: description: Notification Source Name as defined in configuration file. maxLength: 100 type: string providers: items: $ref: '#/components/schemas/NestedProvider' type: array slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - id - name - providers - slug - url type: object NullEnum: enum: - null ObjectChange: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: action: properties: label: enum: - Created - Updated - Deleted type: string value: enum: - create - update - delete type: string readOnly: true type: object changed_object: additionalProperties: {} nullable: true readOnly: true type: object changed_object_id: format: uuid type: string changed_object_type: readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string object_data: additionalProperties: {} readOnly: true type: object request_id: format: uuid readOnly: true type: string time: format: date-time readOnly: true type: string url: format: uri readOnly: true type: string user: allOf: - $ref: '#/components/schemas/NestedUser' readOnly: true user_name: readOnly: true type: string required: - action - changed_object - changed_object_id - changed_object_type - display - id - object_data - request_id - time - url - user - user_name type: object ObjectPermission: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: actions: additionalProperties: {} description: The list of actions granted by this permission type: object constraints: additionalProperties: {} description: Queryset filter matching the applicable objects of the selected type(s) nullable: true type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string enabled: type: boolean groups: items: properties: display: description: Human friendly display value readOnly: true type: string id: readOnly: true type: integer name: maxLength: 150 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object type: array id: format: uuid readOnly: true type: string name: maxLength: 100 type: string object_types: items: type: string type: array url: format: uri readOnly: true type: string users: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 pattern: ^[\w.@+-]+$ type: string required: - display - id - url - username type: object type: array required: - actions - display - id - name - object_types - url type: object OnboardingTask: description: Serializer for the OnboardingTask model. properties: created_device: description: Created device name readOnly: true type: string device_type: description: Nautobot device type 'slug' value type: string failed_reason: description: Failure reason readOnly: true type: string id: format: uuid readOnly: true type: string ip_address: description: IP Address to reach device type: string message: description: Status message readOnly: true type: string platform: description: Nautobot Platform 'slug' value type: string port: description: Device PORT to check for online type: integer role: description: Nautobot device role 'slug' value type: string site: description: Nautobot site 'slug' value type: string status: description: Onboarding Status readOnly: true type: string timeout: description: Timeout (sec) for device connect type: integer required: - created_device - failed_reason - id - ip_address - message - site - status type: object OnboardingTaskRequest: description: Serializer for the OnboardingTask model. properties: device_type: description: Nautobot device type 'slug' value minLength: 1 type: string ip_address: description: IP Address to reach device minLength: 1 type: string password: description: Device password minLength: 1 type: string writeOnly: true platform: description: Nautobot Platform 'slug' value type: string port: description: Device PORT to check for online type: integer role: description: Nautobot device role 'slug' value type: string secret: description: Device secret password minLength: 1 type: string writeOnly: true site: description: Nautobot site 'slug' value type: string timeout: description: Timeout (sec) for device connect type: integer username: description: Device username minLength: 1 type: string writeOnly: true required: - ip_address - site type: object OperatorEnum: enum: - union - intersection - difference type: string OuterUnitEnum: enum: - mm - in type: string PaginatedAccessGrantList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AccessGrant' type: array type: object PaginatedAddressFamilyList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AddressFamily' type: array type: object PaginatedAddressObjectGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AddressObjectGroup' type: array type: object PaginatedAddressObjectList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AddressObject' type: array type: object PaginatedAggregateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Aggregate' type: array type: object PaginatedAutonomousSystemList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AutonomousSystem' type: array type: object PaginatedAvailableIPList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AvailableIP' type: array type: object PaginatedAvailablePrefixList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/AvailablePrefix' type: array type: object PaginatedBGPRoutingInstanceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/BGPRoutingInstance' type: array type: object PaginatedCVELCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CVELCM' type: array type: object PaginatedCableList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Cable' type: array type: object PaginatedCapircaPolicyList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CapircaPolicy' type: array type: object PaginatedCircuitList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Circuit' type: array type: object PaginatedCircuitMaintenanceCircuitImpactList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' type: array type: object PaginatedCircuitMaintenanceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CircuitMaintenance' type: array type: object PaginatedCircuitTerminationList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CircuitTermination' type: array type: object PaginatedCircuitTypeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CircuitType' type: array type: object PaginatedClusterGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ClusterGroup' type: array type: object PaginatedClusterList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Cluster' type: array type: object PaginatedClusterTypeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ClusterType' type: array type: object PaginatedCommandTokenList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CommandToken' type: array type: object PaginatedComplianceFeatureList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ComplianceFeature' type: array type: object PaginatedComplianceRuleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ComplianceRule' type: array type: object PaginatedComputedFieldList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ComputedField' type: array type: object PaginatedConfigComplianceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConfigCompliance' type: array type: object PaginatedConfigContextList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConfigContext' type: array type: object PaginatedConfigContextSchemaList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConfigContextSchema' type: array type: object PaginatedConfigRemoveList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConfigRemove' type: array type: object PaginatedConfigReplaceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConfigReplace' type: array type: object PaginatedConsolePortList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConsolePort' type: array type: object PaginatedConsolePortTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConsolePortTemplate' type: array type: object PaginatedConsoleServerPortList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConsoleServerPort' type: array type: object PaginatedConsoleServerPortTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ConsoleServerPortTemplate' type: array type: object PaginatedContactLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ContactLCM' type: array type: object PaginatedContentTypeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ContentType' type: array type: object PaginatedContractLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ContractLCM' type: array type: object PaginatedCustomFieldChoiceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CustomFieldChoice' type: array type: object PaginatedCustomFieldSerializerVersion12List: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CustomFieldSerializerVersion12' type: array type: object PaginatedCustomLinkList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/CustomLink' type: array type: object PaginatedDeviceBayList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DeviceBay' type: array type: object PaginatedDeviceBayTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DeviceBayTemplate' type: array type: object PaginatedDeviceRedundancyGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DeviceRedundancyGroup' type: array type: object PaginatedDeviceRoleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DeviceRole' type: array type: object PaginatedDeviceTypeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DeviceType' type: array type: object PaginatedDeviceWithConfigContextList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DeviceWithConfigContext' type: array type: object PaginatedDynamicGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DynamicGroup' type: array type: object PaginatedDynamicGroupMembershipList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/DynamicGroupMembership' type: array type: object PaginatedExportTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ExportTemplate' type: array type: object PaginatedFQDNList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/FQDN' type: array type: object PaginatedFrontPortList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/FrontPort' type: array type: object PaginatedFrontPortTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/FrontPortTemplate' type: array type: object PaginatedGitRepositoryList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/GitRepository' type: array type: object PaginatedGoldenConfigList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/GoldenConfig' type: array type: object PaginatedGoldenConfigSettingList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/GoldenConfigSetting' type: array type: object PaginatedGraphQLQueryList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/GraphQLQuery' type: array type: object PaginatedGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Group' type: array type: object PaginatedHardwareLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/HardwareLCM' type: array type: object PaginatedIPAddressList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/IPAddress' type: array type: object PaginatedIPRangeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/IPRange' type: array type: object PaginatedImageAttachmentList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ImageAttachment' type: array type: object PaginatedInterfaceConnectionList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/InterfaceConnection' type: array type: object PaginatedInterfaceSerializerVersion12List: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/InterfaceSerializerVersion12' type: array type: object PaginatedInterfaceTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/InterfaceTemplate' type: array type: object PaginatedInventoryItemList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/InventoryItem' type: array type: object PaginatedJobHookList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/JobHook' type: array type: object PaginatedJobList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Job' type: array type: object PaginatedJobLogEntryList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/JobLogEntry' type: array type: object PaginatedJobResultList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/JobResult' type: array type: object PaginatedJobVariableList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/JobVariable' type: array type: object PaginatedLocationList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Location' type: array type: object PaginatedLocationTypeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/LocationType' type: array type: object PaginatedManufacturerList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Manufacturer' type: array type: object PaginatedMinMaxValidationRuleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/MinMaxValidationRule' type: array type: object PaginatedNATPolicyList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/NATPolicy' type: array type: object PaginatedNATPolicyRuleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/NATPolicyRule' type: array type: object PaginatedNoteList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Note' type: array type: object PaginatedNotificationSourceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/NotificationSource' type: array type: object PaginatedObjectChangeList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ObjectChange' type: array type: object PaginatedObjectPermissionList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ObjectPermission' type: array type: object PaginatedOnboardingTaskList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/OnboardingTask' type: array type: object PaginatedPeerEndpointList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PeerEndpoint' type: array type: object PaginatedPeerGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PeerGroup' type: array type: object PaginatedPeerGroupTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PeerGroupTemplate' type: array type: object PaginatedPeeringList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Peering' type: array type: object PaginatedPeeringRoleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PeeringRole' type: array type: object PaginatedPlatformList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Platform' type: array type: object PaginatedPolicyList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Policy' type: array type: object PaginatedPolicyRuleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PolicyRule' type: array type: object PaginatedPowerFeedList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PowerFeed' type: array type: object PaginatedPowerOutletList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PowerOutlet' type: array type: object PaginatedPowerOutletTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PowerOutletTemplate' type: array type: object PaginatedPowerPanelList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PowerPanel' type: array type: object PaginatedPowerPortList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PowerPort' type: array type: object PaginatedPowerPortTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/PowerPortTemplate' type: array type: object PaginatedPrefixList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Prefix' type: array type: object PaginatedProviderLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ProviderLCM' type: array type: object PaginatedProviderList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Provider' type: array type: object PaginatedProviderNetworkList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ProviderNetwork' type: array type: object PaginatedRIRList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RIR' type: array type: object PaginatedRackGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RackGroup' type: array type: object PaginatedRackList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Rack' type: array type: object PaginatedRackReservationList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RackReservation' type: array type: object PaginatedRackRoleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RackRole' type: array type: object PaginatedRackUnitList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RackUnit' type: array type: object PaginatedRearPortList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RearPort' type: array type: object PaginatedRearPortTemplateList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RearPortTemplate' type: array type: object PaginatedRegionList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Region' type: array type: object PaginatedRegularExpressionValidationRuleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RegularExpressionValidationRule' type: array type: object PaginatedRelationshipAssociationList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RelationshipAssociation' type: array type: object PaginatedRelationshipList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Relationship' type: array type: object PaginatedRoleList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Role' type: array type: object PaginatedRouteTargetList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/RouteTarget' type: array type: object PaginatedScheduledJobList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ScheduledJob' type: array type: object PaginatedSecretList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Secret' type: array type: object PaginatedSecretsGroupAssociationList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/SecretsGroupAssociation' type: array type: object PaginatedSecretsGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/SecretsGroup' type: array type: object PaginatedServiceList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Service' type: array type: object PaginatedServiceObjectGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ServiceObjectGroup' type: array type: object PaginatedServiceObjectList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ServiceObject' type: array type: object PaginatedSiteList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Site' type: array type: object PaginatedSoftwareImageLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/SoftwareImageLCM' type: array type: object PaginatedSoftwareLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/SoftwareLCM' type: array type: object PaginatedStatusList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Status' type: array type: object PaginatedTagSerializerVersion13List: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/TagSerializerVersion13' type: array type: object PaginatedTenantGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/TenantGroup' type: array type: object PaginatedTenantList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Tenant' type: array type: object PaginatedTokenList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Token' type: array type: object PaginatedUserList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/User' type: array type: object PaginatedUserObjectGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/UserObjectGroup' type: array type: object PaginatedUserObjectList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/UserObject' type: array type: object PaginatedVLANGroupList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VLANGroup' type: array type: object PaginatedVLANList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VLAN' type: array type: object PaginatedVMInterfaceSerializerVersion12List: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' type: array type: object PaginatedVRFList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VRF' type: array type: object PaginatedValidatedSoftwareLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/ValidatedSoftwareLCM' type: array type: object PaginatedVirtualChassisList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VirtualChassis' type: array type: object PaginatedVirtualMachineWithConfigContextList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VirtualMachineWithConfigContext' type: array type: object PaginatedVulnerabilityLCMList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/VulnerabilityLCM' type: array type: object PaginatedWebhookList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Webhook' type: array type: object PaginatedZoneList: properties: count: example: 123 type: integer next: example: http://api.example.org/accounts/?offset=400&limit=100 format: uri nullable: true type: string previous: example: http://api.example.org/accounts/?offset=200&limit=100 format: uri nullable: true type: string results: items: $ref: '#/components/schemas/Zone' type: array type: object PatchedAccessGrantRequest: description: API serializer for interacting with AccessGrant objects. properties: command: description: Enter * to grant access to all commands maxLength: 64 minLength: 1 type: string grant_type: $ref: '#/components/schemas/GrantTypeEnum' name: description: Organization name, channel name, or user name maxLength: 255 minLength: 1 type: string subcommand: description: Enter * to grant access to all subcommands of the given command maxLength: 64 minLength: 1 type: string value: description: Corresponding ID value to grant access to.
Enter * to grant access to all organizations, channels, or users maxLength: 255 minLength: 1 type: string type: object PatchedBulkWritableAccessGrantRequest: description: API serializer for interacting with AccessGrant objects. properties: command: description: Enter * to grant access to all commands maxLength: 64 minLength: 1 type: string grant_type: $ref: '#/components/schemas/GrantTypeEnum' id: format: uuid type: string name: description: Organization name, channel name, or user name maxLength: 255 minLength: 1 type: string subcommand: description: Enter * to grant access to all subcommands of the given command maxLength: 64 minLength: 1 type: string value: description: Corresponding ID value to grant access to.
Enter * to grant access to all organizations, channels, or users maxLength: 255 minLength: 1 type: string required: - id type: object PatchedBulkWritableAddressFamilyRequest: description: REST API serializer for AddressFamily records. properties: afi_safi: $ref: '#/components/schemas/AfiSafiEnum' custom_fields: additionalProperties: {} type: object export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string vrf: allOf: - $ref: '#/components/schemas/NestedVRFRequest' nullable: true required: - id type: object PatchedBulkWritableAddressObjectGroupRequest: description: AddressObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableAddressObjectRequest: description: AddressObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' id: format: uuid type: string ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableAggregateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object date_added: format: date nullable: true type: string description: maxLength: 200 type: string id: format: uuid type: string prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object rir: $ref: '#/components/schemas/NestedRIRRequest' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id type: object PatchedBulkWritableAutonomousSystemRequest: description: REST API serializer for AutonomousSystem records. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderRequest' nullable: true status: $ref: '#/components/schemas/Status2a0Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableBGPRoutingInstanceRequest: description: REST API serializer for Peering records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string router_id: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true required: - id type: object PatchedBulkWritableCVELCMRequest: description: REST API serializer for CVELCM records. properties: comments: type: string custom_fields: additionalProperties: {} type: object cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string fix: maxLength: 255 nullable: true type: string id: format: uuid type: string link: format: uri maxLength: 200 minLength: 1 type: string name: maxLength: 16 minLength: 1 type: string published_date: format: date type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object severity: $ref: '#/components/schemas/SeverityEnum' status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableCableRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string label: maxLength: 100 type: string length: maximum: 32767 minimum: 0 nullable: true type: integer length_unit: $ref: '#/components/schemas/LengthUnitEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CableStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array termination_a_id: format: uuid type: string termination_a_type: type: string termination_b_id: format: uuid type: string termination_b_type: type: string type: oneOf: - $ref: '#/components/schemas/CableTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - id type: object PatchedBulkWritableCapircaPolicyRequest: description: CapircaPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object cfg: nullable: true type: string custom_fields: additionalProperties: {} type: object device: format: uuid nullable: true type: string id: format: uuid type: string net: nullable: true type: string pol: nullable: true type: string svc: nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableCircuitMaintenanceCircuitImpactRequest: description: Serializer for API. properties: circuit: format: uuid type: string id: format: uuid type: string impact: nullable: true oneOf: - $ref: '#/components/schemas/ImpactEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' maintenance: format: uuid type: string required: - id type: object PatchedBulkWritableCircuitMaintenanceRequest: description: Serializer for API. properties: ack: nullable: true type: boolean description: nullable: true type: string end_time: format: date-time type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string start_time: format: date-time type: string status: nullable: true oneOf: - $ref: '#/components/schemas/StatusD95Enum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - id type: object PatchedBulkWritableCircuitRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cid: maxLength: 100 minLength: 1 title: Circuit ID type: string comments: type: string commit_rate: maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string install_date: format: date nullable: true title: Date installed type: string provider: $ref: '#/components/schemas/NestedProviderRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CircuitStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true type: $ref: '#/components/schemas/NestedCircuitTypeRequest' required: - id type: object PatchedBulkWritableCircuitTerminationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: circuit: $ref: '#/components/schemas/NestedCircuitRequest' custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer pp_info: maxLength: 100 title: Patch panel/port(s) type: string provider_network: allOf: - $ref: '#/components/schemas/NestedProviderNetworkRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true term_side: allOf: - $ref: '#/components/schemas/TermSideEnum' title: Termination upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer xconnect_id: maxLength: 50 title: Cross-connect ID type: string required: - id type: object PatchedBulkWritableCircuitTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableClusterGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableClusterRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object group: allOf: - $ref: '#/components/schemas/NestedClusterGroupRequest' nullable: true id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true type: $ref: '#/components/schemas/NestedClusterTypeRequest' required: - id type: object PatchedBulkWritableClusterTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableCommandTokenRequest: description: API serializer for interacting with CommandToken objects. properties: comment: description: 'Optional: Enter description of token' maxLength: 255 type: string id: format: uuid type: string platform: $ref: '#/components/schemas/PlatformEnum' token: description: Token given by chat platform for signing or command validation maxLength: 255 minLength: 1 type: string required: - id type: object PatchedBulkWritableComplianceFeatureRequest: description: Serializer for ComplianceFeature object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableComplianceRuleRequest: description: Serializer for ComplianceRule object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object config_ordered: description: Whether or not the configuration order matters, such as in ACLs. title: Configured Ordered type: boolean config_type: allOf: - $ref: '#/components/schemas/ConfigTypeEnum' description: Whether the config is in cli or json/structured format. custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string feature: format: uuid type: string id: format: uuid type: string match_config: description: The config to match that is matched based on the parent most configuration. e.g. `router bgp` or `ntp`. nullable: true title: Config to Match type: string platform: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableComputedFieldRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string description: maxLength: 200 type: string fallback_value: description: Fallback value (if any) to be output for the field in the case of a template rendering error. maxLength: 500 type: string id: format: uuid type: string label: description: Name of the field as displayed to users maxLength: 100 minLength: 1 type: string slug: description: Internal field name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string template: description: Jinja2 template code for field value maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableConfigComplianceRequest: description: Serializer for ConfigCompliance object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object actual: additionalProperties: {} description: Actual Configuration for feature type: object compliance: nullable: true type: boolean compliance_int: maximum: 2147483647 minimum: -2147483648 nullable: true type: integer custom_fields: additionalProperties: {} type: object device: description: The device format: uuid type: string extra: additionalProperties: {} description: Configuration that should not be on the device. type: object id: format: uuid type: string intended: additionalProperties: {} description: Intended Configuration for feature type: object missing: additionalProperties: {} description: Configuration that should be on the device. type: object ordered: type: boolean rule: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableConfigContextRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: cluster_groups: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array clusters: items: properties: name: maxLength: 100 minLength: 1 type: string required: - name type: object type: array data: additionalProperties: {} type: object description: maxLength: 200 type: string device_types: items: properties: model: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - model - slug type: object type: array id: format: uuid type: string is_active: type: boolean locations: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string platforms: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array regions: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array roles: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchemaRequest' nullable: true sites: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array tags: items: type: string type: array tenant_groups: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array tenants: items: properties: name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object type: array weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableConfigContextSchemaRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object data_schema: additionalProperties: {} description: A JSON Schema document which is used to validate a config context object. type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 200 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableConfigRemoveRequest: description: Serializer for ConfigRemove object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern used to remove a line from the backup configuration. maxLength: 200 minLength: 1 title: Regex Pattern type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableConfigReplaceRequest: description: Serializer for ConfigReplace object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern that will be found and replaced with 'replaced text'. maxLength: 200 minLength: 1 title: Regex Pattern to Substitute type: string replace: description: Text that will be inserted in place of Regex pattern match. maxLength: 200 minLength: 1 title: Replaced Text type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableConsolePortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - id type: object PatchedBulkWritableConsolePortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - id type: object PatchedBulkWritableConsoleServerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - id type: object PatchedBulkWritableConsoleServerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/ConsolePortTypeChoices' required: - id type: object PatchedBulkWritableContactLCMRequest: description: API serializer. properties: address: maxLength: 200 type: string comments: type: string contract: allOf: - $ref: '#/components/schemas/NestedContractLCMRequest' description: Associated Contract custom_fields: additionalProperties: {} type: object email: format: email maxLength: 254 title: Contact E-mail type: string id: format: uuid type: string name: maxLength: 80 minLength: 1 nullable: true type: string phone: maxLength: 20 type: string priority: maximum: 2147483647 minimum: 0 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableContractLCMRequest: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string custom_fields: additionalProperties: {} type: object end: format: date nullable: true title: Contract End Date type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string provider: allOf: - $ref: '#/components/schemas/NestedProviderLCMRequest' description: Vendor relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableCustomFieldChoiceRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: field: $ref: '#/components/schemas/NestedCustomFieldRequest' id: format: uuid type: string value: maxLength: 100 minLength: 1 type: string weight: description: Higher weights appear later in the list maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableCustomLinkRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: button_class: allOf: - $ref: '#/components/schemas/ButtonClassEnum' description: The class of the first link in a group will be used for the dropdown button content_type: type: string group_name: description: Links with the same group will appear as a dropdown menu maxLength: 50 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string new_window: description: Force link to open in a new window type: boolean target_url: description: Jinja2 template code for link URL. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. maxLength: 500 minLength: 1 title: URL type: string text: description: Jinja2 template code for link text. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. Links which render as empty text will not be displayed. maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableDeviceBayRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string installed_device: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableDeviceBayTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object required: - id type: object PatchedBulkWritableDeviceRedundancyGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string failover_strategy: $ref: '#/components/schemas/FailoverStrategyEnum' id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableDeviceRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string vm_role: description: Virtual machines may be assigned to this role type: boolean required: - id type: object PatchedBulkWritableDeviceTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object front_image: format: binary type: string id: format: uuid type: string is_full_depth: description: Device consumes both front and rear rack faces type: boolean manufacturer: $ref: '#/components/schemas/NestedManufacturerRequest' model: maxLength: 100 minLength: 1 type: string part_number: description: Discrete part number (optional) maxLength: 50 type: string rear_image: format: binary type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string subdevice_role: $ref: '#/components/schemas/SubdeviceRoleEnum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array u_height: maximum: 32767 minimum: 0 title: Height (U) type: integer required: - id type: object PatchedBulkWritableDeviceWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: allOf: - $ref: '#/components/schemas/NestedClusterRequest' nullable: true comments: type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: allOf: - $ref: '#/components/schemas/NestedDeviceRedundancyGroupRequest' nullable: true device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: $ref: '#/components/schemas/NestedDeviceRoleRequest' device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' face: $ref: '#/components/schemas/FaceEnum' id: format: uuid type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchemaRequest' nullable: true location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 64 nullable: true type: string platform: allOf: - $ref: '#/components/schemas/NestedPlatformRequest' nullable: true position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true rack: allOf: - $ref: '#/components/schemas/NestedRackRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroupRequest' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSiteRequest' status: $ref: '#/components/schemas/DeviceStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: allOf: - $ref: '#/components/schemas/NestedVirtualChassisRequest' nullable: true required: - id type: object PatchedBulkWritableDynamicGroupMembershipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: group: $ref: '#/components/schemas/NestedDynamicGroupRequest' id: format: uuid type: string operator: $ref: '#/components/schemas/OperatorEnum' parent_group: $ref: '#/components/schemas/NestedDynamicGroupRequest' weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableDynamicGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_type: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string filter: additionalProperties: {} description: A JSON-encoded dictionary of filter parameters for group membership type: object id: format: uuid type: string name: description: Dynamic Group name maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableExportTemplateRequest: description: Extend ValidatedModelSerializer with a `relationships` field. properties: content_type: type: string description: maxLength: 200 type: string file_extension: description: Extension to append to the rendered filename maxLength: 15 type: string id: format: uuid type: string mime_type: description: Defaults to text/plain maxLength: 50 type: string name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object template_code: description: The list of objects being exported is passed as a context variable named queryset. minLength: 1 type: string required: - id type: object PatchedBulkWritableFQDNRequest: description: FQDN Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string ip_addresses: items: properties: address: minLength: 1 type: string required: - address type: object type: array name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableFrontPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: $ref: '#/components/schemas/FrontPortRearPortRequest' rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' required: - id type: object PatchedBulkWritableFrontPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: $ref: '#/components/schemas/NestedRearPortTemplateRequest' rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' required: - id type: object PatchedBulkWritableGitRepositoryRequest: description: Git repositories defined as a data source. properties: branch: maxLength: 64 minLength: 1 type: string current_head: description: Commit hash of the most recent fetch from the selected branch. Used for syncing between workers. maxLength: 48 type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string provided_contents: items: oneOf: - $ref: '#/components/schemas/ProvidedContentsEnum' - $ref: '#/components/schemas/BlankEnum' type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remote_url: description: Only HTTP and HTTPS URLs are presently supported format: uri maxLength: 255 minLength: 1 type: string secrets_group: allOf: - $ref: '#/components/schemas/NestedSecretsGroupRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string token: minLength: 1 type: string writeOnly: true username: maxLength: 64 type: string required: - id type: object PatchedBulkWritableGoldenConfigRequest: description: Serializer for GoldenConfig object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_config: description: Full backup config for device. type: string backup_last_attempt_date: format: date-time nullable: true type: string backup_last_success_date: format: date-time nullable: true type: string compliance_config: description: Full config diff for device. type: string compliance_last_attempt_date: format: date-time nullable: true type: string compliance_last_success_date: format: date-time nullable: true type: string custom_fields: additionalProperties: {} type: object device: description: device format: uuid type: string id: format: uuid type: string intended_config: description: Intended config for the device. type: string intended_last_attempt_date: format: date-time nullable: true type: string intended_last_success_date: format: date-time nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableGoldenConfigSettingRequest: description: Serializer for GoldenConfigSetting object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_path_template: description: The Jinja path representation of where the backup file will be found. The variable `obj` is available as the device instance object of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Backup Path in Jinja Template Form type: string backup_repository: format: uuid nullable: true type: string backup_test_connectivity: description: Whether or not to pretest the connectivity of the device by verifying there is a resolvable IP that can connect to port 22. title: Backup Test type: boolean custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dynamic_group: $ref: '#/components/schemas/NestedDynamicGroupRequest' id: format: uuid type: string intended_path_template: description: The Jinja path representation of where the generated file will be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Intended Path in Jinja Template Form type: string intended_repository: format: uuid nullable: true type: string jinja_path_template: description: The Jinja path representation of where the Jinja template can be found. e.g. `{{obj.platform.slug}}.j2` maxLength: 255 title: Template Path in Jinja Template Form type: string jinja_repository: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string scope: additionalProperties: {} type: object slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string sot_agg_query: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableGraphQLQueryRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string query: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string variables: additionalProperties: {} default: {} nullable: true type: object required: - id type: object PatchedBulkWritableGroupRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: id: type: integer name: maxLength: 150 minLength: 1 type: string required: - id type: object PatchedBulkWritableHardwareLCMRequest: description: API serializer. properties: custom_fields: additionalProperties: {} type: object device_type: allOf: - $ref: '#/components/schemas/NestedDeviceTypeRequest' description: Device Type to attach the Hardware LCM to documentation_url: format: uri maxLength: 200 type: string end_of_sale: format: date nullable: true type: string end_of_security_patches: format: date nullable: true type: string end_of_support: format: date nullable: true type: string end_of_sw_releases: format: date nullable: true title: End of Software Releases type: string id: format: uuid type: string inventory_item: maxLength: 255 nullable: true title: Inventory Item Part type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableIPAddressRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: address: minLength: 1 type: string assigned_object_id: format: uuid nullable: true type: string assigned_object_type: nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dns_name: description: Hostname or FQDN (not case-sensitive) maxLength: 255 pattern: ^[0-9A-Za-z._-]+$ type: string id: format: uuid type: string nat_inside: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: $ref: '#/components/schemas/RoleEnum' status: $ref: '#/components/schemas/IPAddressStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vrf: allOf: - $ref: '#/components/schemas/NestedVRFRequest' nullable: true required: - id type: object PatchedBulkWritableIPRangeRequest: description: IPRange Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string end_address: minLength: 1 type: string id: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start_address: minLength: 1 type: string status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array vrf: format: uuid nullable: true type: string required: - id type: object PatchedBulkWritableImageAttachmentRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string id: format: uuid type: string image: format: binary type: string image_height: maximum: 32767 minimum: 0 type: integer image_width: maximum: 32767 minimum: 0 type: integer name: maxLength: 50 type: string object_id: format: uuid type: string required: - id type: object PatchedBulkWritableInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' enabled: type: boolean id: format: uuid type: string label: description: Physical label maxLength: 64 type: string lag: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true mac_address: maxLength: 18 nullable: true type: string mgmt_only: description: This interface is used only for out-of-band management title: Management only type: boolean mode: $ref: '#/components/schemas/ModeEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: properties: name: maxLength: 64 minLength: 1 type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - name - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/InterfaceTypeChoices' untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true required: - id type: object PatchedBulkWritableInterfaceTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string mgmt_only: title: Management only type: boolean name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/InterfaceTypeChoices' required: - id type: object PatchedBulkWritableInventoryItemRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this item maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' discovered: description: This item was automatically discovered type: boolean id: format: uuid type: string label: description: Physical label maxLength: 64 type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturerRequest' nullable: true name: maxLength: 64 minLength: 1 type: string parent: format: uuid nullable: true type: string part_id: description: Manufacturer-assigned part identifier maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object serial: maxLength: 255 title: Serial number type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableJobHookRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object enabled: type: boolean id: format: uuid type: string job: description: The job that this job hook will initiate format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type_create: description: Call this job hook when a matching object is created. type: boolean type_delete: description: Call this job hook when a matching object is deleted. type: boolean type_update: description: Call this job hook when a matching object is updated. type: boolean required: - id type: object PatchedBulkWritableJobRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: approval_required: description: Whether the job requires approval from another user before running type: boolean approval_required_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean commit_default: description: Whether the job defaults to committing changes when run, or defaults to a dry-run type: boolean commit_default_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean custom_fields: additionalProperties: {} type: object description: description: Markdown formatting is supported type: string description_override: description: If set, the configured description will remain even if the underlying Job source code changes type: boolean enabled: description: Whether this job can be executed by users type: boolean grouping: description: Human-readable grouping that this job belongs to maxLength: 255 minLength: 1 type: string grouping_override: description: If set, the configured grouping will remain even if the underlying Job source code changes type: boolean has_sensitive_variables: description: Whether this job contains sensitive variables type: boolean has_sensitive_variables_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean hidden: description: Whether the job defaults to not being shown in the UI type: boolean hidden_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean id: format: uuid type: string name: description: Human-readable name of this job maxLength: 100 minLength: 1 type: string name_override: description: If set, the configured name will remain even if the underlying Job source code changes type: boolean read_only: description: Whether the job is prevented from making lasting changes to the database type: boolean read_only_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 320 pattern: ^[-a-zA-Z0-9_]+$ type: string soft_time_limit: description: Maximum runtime in seconds before the job will receive a SoftTimeLimitExceeded exception.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number soft_time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array task_queues: additionalProperties: {} description: Comma separated list of task queues that this job can run on. A blank list will use the default queue type: object task_queues_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean time_limit: description: Maximum runtime in seconds before the job will be forcibly terminated.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean required: - id type: object PatchedBulkWritableLocationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location_type: $ref: '#/components/schemas/NestedLocationTypeRequest' name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id type: object PatchedBulkWritableLocationTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string nestable: description: Allow Locations of this type to be parents/children of other Locations of this same type type: boolean parent: allOf: - $ref: '#/components/schemas/NestedLocationTypeRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableManufacturerRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableMinMaxValidationRuleRequest: description: Serializer for `MinMaxValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string id: format: uuid type: string max: description: When set, apply a maximum value contraint to the value of the model field. format: double nullable: true type: number min: description: When set, apply a minimum value contraint to the value of the model field. format: double nullable: true type: number name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableNATPolicyRequest: description: NATPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - id type: object PatchedBulkWritableNATPolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/ZoneRequest' id: format: uuid type: string index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string original_destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array original_source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_source_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array original_source_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remark: type: boolean request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array translated_destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array translated_source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_source_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array translated_source_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array required: - id type: object PatchedBulkWritableNoteRequest: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: assigned_object_id: format: uuid type: string assigned_object_type: type: string id: format: uuid type: string note: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableObjectPermissionRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: actions: additionalProperties: {} description: The list of actions granted by this permission type: object constraints: additionalProperties: {} description: Queryset filter matching the applicable objects of the selected type(s) nullable: true type: object description: maxLength: 200 type: string enabled: type: boolean groups: items: properties: name: maxLength: 150 minLength: 1 type: string required: - name type: object type: array id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string object_types: items: type: string type: array users: items: properties: username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string required: - username type: object type: array required: - id type: object PatchedBulkWritablePeerEndpointRequest: description: REST API serializer for PeerEndpoint records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string peer_group: allOf: - $ref: '#/components/schemas/NestedPeerGroupRequest' nullable: true peering: allOf: - $ref: '#/components/schemas/NestedPeeringRequest' nullable: true secret: allOf: - $ref: '#/components/schemas/NestedSecretRequest' nullable: true source_interface: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true source_ip: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritablePeerGroupRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string secret: allOf: - $ref: '#/components/schemas/NestedSecretRequest' nullable: true source_interface: allOf: - $ref: '#/components/schemas/NestedInterfaceRequest' nullable: true source_ip: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true template: allOf: - $ref: '#/components/schemas/NestedPeerGroupTemplateRequest' nullable: true required: - id type: object PatchedBulkWritablePeerGroupTemplateRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystemRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string secret: allOf: - $ref: '#/components/schemas/NestedSecretRequest' nullable: true required: - id type: object PatchedBulkWritablePeeringRequest: description: REST API serializer for Peering records. properties: custom_fields: additionalProperties: {} type: object id: format: uuid type: string status: $ref: '#/components/schemas/CircuitStatusChoices' required: - id type: object PatchedBulkWritablePeeringRoleRequest: description: REST API serializer for PeeringRole records. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritablePlatformRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturerRequest' nullable: true name: maxLength: 100 minLength: 1 type: string napalm_args: additionalProperties: {} description: Additional arguments to pass when initiating the NAPALM driver (JSON format) nullable: true title: NAPALM arguments type: object napalm_driver: description: The name of the NAPALM driver to use when interacting with devices maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritablePolicyRequest: description: Policy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - id type: object PatchedBulkWritablePolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object action: $ref: '#/components/schemas/ActionEnum' custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array destination_zone: $ref: '#/components/schemas/ZoneRequest' id: format: uuid type: string index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object request_id: maxLength: 100 nullable: true type: string source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: $ref: '#/components/schemas/NestedFQDNRequest' ip_address: $ref: '#/components/schemas/NestedIPAddressRequest' ip_range: $ref: '#/components/schemas/NestedIPRangeRequest' name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: $ref: '#/components/schemas/NestedPrefixRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object type: array source_user_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array user_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object type: array required: - name type: object type: array source_users: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object type: array source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritablePowerFeedRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: amperage: maximum: 32767 minimum: 1 type: integer comments: type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string max_utilization: description: Maximum permissible draw (percentage) maximum: 100 minimum: 1 type: integer name: maxLength: 100 minLength: 1 type: string phase: allOf: - $ref: '#/components/schemas/PhaseEnum' default: label: Single phase value: single-phase power_panel: $ref: '#/components/schemas/NestedPowerPanelRequest' rack: allOf: - $ref: '#/components/schemas/NestedRackRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/PowerFeedStatusChoices' supply: allOf: - $ref: '#/components/schemas/SupplyEnum' default: label: AC value: ac tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: allOf: - $ref: '#/components/schemas/PowerFeedTypeChoices' default: label: Primary value: primary voltage: maximum: 32767 minimum: -32768 type: integer required: - id type: object PatchedBulkWritablePowerOutletRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' feed_leg: $ref: '#/components/schemas/FeedLegEnum' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: $ref: '#/components/schemas/NestedPowerPortRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PowerOutletTypeChoices' required: - id type: object PatchedBulkWritablePowerOutletTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' feed_leg: $ref: '#/components/schemas/FeedLegEnum' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: $ref: '#/components/schemas/NestedPowerPortTemplateRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PowerOutletTypeChoices' required: - id type: object PatchedBulkWritablePowerPanelRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string rack_group: allOf: - $ref: '#/components/schemas/NestedRackGroupRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: $ref: '#/components/schemas/NestedSiteRequest' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritablePowerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PowerPortTypeChoices' required: - id type: object PatchedBulkWritablePowerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PowerPortTypeChoices' required: - id type: object PatchedBulkWritablePrefixRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string is_pool: description: All IP addresses within this prefix are considered usable title: Is a pool type: boolean location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedRoleRequest' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true status: $ref: '#/components/schemas/PrefixStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true vrf: allOf: - $ref: '#/components/schemas/NestedVRFRequest' nullable: true required: - id type: object PatchedBulkWritableProviderLCMRequest: description: API serializer. properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string email: format: email maxLength: 254 title: E-mail type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableProviderNetworkRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string provider: $ref: '#/components/schemas/NestedProviderRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableProviderRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: account: maxLength: 100 title: Account number type: string admin_contact: type: string asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string noc_contact: type: string portal_url: format: uri maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableRIRRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string is_private: description: IP space managed by this RIR is considered private title: Private type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableRackGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedRackGroupRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: $ref: '#/components/schemas/NestedSiteRequest' slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableRackRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this rack maxLength: 50 nullable: true type: string comments: type: string custom_fields: additionalProperties: {} type: object desc_units: description: Units are numbered top-to-bottom title: Descending units type: boolean facility_id: description: Locally-assigned identifier maxLength: 50 nullable: true type: string group: allOf: - $ref: '#/components/schemas/NestedRackGroupRequest' nullable: true id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string outer_depth: description: Outer dimension of rack (depth) maximum: 32767 minimum: 0 nullable: true type: integer outer_unit: $ref: '#/components/schemas/OuterUnitEnum' outer_width: description: Outer dimension of rack (width) maximum: 32767 minimum: 0 nullable: true type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedRackRoleRequest' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSiteRequest' status: $ref: '#/components/schemas/RackStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true type: $ref: '#/components/schemas/RackTypeChoices' u_height: description: Height in rack units maximum: 100 minimum: 1 title: Height (U) type: integer width: $ref: '#/components/schemas/WidthEnum' required: - id type: object PatchedBulkWritableRackReservationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 minLength: 1 type: string id: format: uuid type: string rack: $ref: '#/components/schemas/NestedRackRequest' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true units: additionalProperties: {} type: object user: $ref: '#/components/schemas/NestedUserRequest' required: - id type: object PatchedBulkWritableRackRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableRearPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDeviceRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' required: - id type: object PatchedBulkWritableRearPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceTypeRequest' id: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' required: - id type: object PatchedBulkWritableRegionRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedRegionRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableRegularExpressionValidationRuleRequest: description: Serializer for `RegularExpressionValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string regular_expression: minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableRelationshipAssociationRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: destination_id: format: uuid type: string destination_type: type: string id: format: uuid type: string relationship: $ref: '#/components/schemas/NestedRelationshipRequest' source_id: format: uuid type: string source_type: type: string required: - id type: object PatchedBulkWritableRelationshipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string destination_filter: additionalProperties: {} description: Filterset filter matching the applicable destination objects of the selected type nullable: true type: object destination_hidden: description: Hide this relationship on the destination object. title: Hide for destination object type: boolean destination_label: description: Label for related source objects, as displayed on the destination object. maxLength: 50 type: string destination_type: type: string id: format: uuid type: string name: description: Name of the relationship as displayed to users maxLength: 100 minLength: 1 type: string required_on: description: Objects on the specified side MUST implement this relationship. Not permitted for symmetric relationships. oneOf: - $ref: '#/components/schemas/RequiredOnEnum' - $ref: '#/components/schemas/BlankEnum' slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string source_filter: additionalProperties: {} description: Filterset filter matching the applicable source objects of the selected type nullable: true type: object source_hidden: description: Hide this relationship on the source object. title: Hide for source object type: boolean source_label: description: Label for related destination objects, as displayed on the source object. maxLength: 50 type: string source_type: type: string type: allOf: - $ref: '#/components/schemas/RelationshipTypeChoices' description: Cardinality of this relationship required: - id type: object PatchedBulkWritableRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PatchedBulkWritableRouteTargetRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id type: object PatchedBulkWritableSecretRequest: description: Serializer for `Secret` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parameters: additionalProperties: {} type: object provider: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableSecretsGroupAssociationRequest: description: Serializer for `SecretsGroupAssociation` objects. properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' group: $ref: '#/components/schemas/NestedSecretsGroupRequest' id: format: uuid type: string secret: $ref: '#/components/schemas/NestedSecretRequest' secret_type: $ref: '#/components/schemas/SecretTypeEnum' required: - id type: object PatchedBulkWritableSecretsGroupRequest: description: Serializer for `SecretsGroup` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableServiceObjectGroupRequest: description: ServiceObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object type: array status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableServiceObjectRequest: description: ServiceObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string ip_protocol: allOf: - $ref: '#/components/schemas/IpProtocolEnum' description: IANA IP Protocol (e.g. TCP UDP ICMP) name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableServiceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true id: format: uuid type: string ipaddresses: items: properties: address: minLength: 1 type: string required: - address type: object type: array name: maxLength: 100 minLength: 1 type: string ports: items: maximum: 65535 minimum: 1 type: integer type: array protocol: $ref: '#/components/schemas/ProtocolEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array virtual_machine: allOf: - $ref: '#/components/schemas/NestedVirtualMachineRequest' nullable: true required: - id type: object PatchedBulkWritableSiteRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string contact_email: format: email maxLength: 254 title: Contact E-mail type: string contact_name: maxLength: 50 type: string contact_phone: maxLength: 20 type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string facility: description: Local facility ID or description maxLength: 50 type: string id: format: uuid type: string latitude: description: GPS coordinate (latitude) format: decimal nullable: true pattern: ^-?\d{0,2}(?:\.\d{0,6})?$ type: string longitude: description: GPS coordinate (longitude) format: decimal nullable: true pattern: ^-?\d{0,3}(?:\.\d{0,6})?$ type: string name: maxLength: 100 minLength: 1 type: string physical_address: maxLength: 200 type: string region: allOf: - $ref: '#/components/schemas/NestedRegionRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object shipping_address: maxLength: 200 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true time_zone: nullable: true type: string required: - id type: object PatchedBulkWritableSoftwareImageLCMRequest: description: REST API serializer for SoftwareImageLCM records. properties: custom_fields: additionalProperties: {} type: object default_image: type: boolean device_types: items: format: uuid type: string type: array download_url: format: uri maxLength: 200 type: string id: format: uuid type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 minLength: 1 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: $ref: '#/components/schemas/NestedSoftwareLCMRequest' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableSoftwareLCMRequest: description: REST API serializer for SoftwareLCM records. properties: alias: maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object device_platform: $ref: '#/components/schemas/NestedPlatformRequest' documentation_url: format: uri maxLength: 200 type: string end_of_support: format: date nullable: true title: End of Software Support type: string id: format: uuid type: string long_term_support: type: boolean pre_release: type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string software_images: items: properties: default_image: type: boolean device_types: items: format: uuid type: string type: array download_url: format: uri maxLength: 200 type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 minLength: 1 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array required: - image_file_name type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array version: maxLength: 50 minLength: 1 type: string required: - id type: object PatchedBulkWritableStatusRequest: description: Serializer for `Status` objects. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: maxLength: 50 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableTagSerializerVersion13Request: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 minLength: 1 pattern: ^[-\w]+$ type: string required: - id type: object PatchedBulkWritableTenantGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parent: allOf: - $ref: '#/components/schemas/NestedTenantGroupRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableTenantRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: $ref: '#/components/schemas/NestedTenantGroupRequest' id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableTokenRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string expires: format: date-time nullable: true type: string id: format: uuid type: string key: maxLength: 40 minLength: 40 type: string write_enabled: description: Permit create/update/delete operations using this key type: boolean required: - id type: object PatchedBulkWritableUserObjectGroupRequest: description: UserObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array user_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: enum: - active - decommissioned - staged type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object type: array required: - id type: object PatchedBulkWritableUserObjectRequest: description: UserObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object id: format: uuid type: string name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - id type: object PatchedBulkWritableUserRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: date_joined: format: date-time type: string email: format: email maxLength: 254 title: Email address type: string first_name: maxLength: 150 type: string groups: items: properties: name: maxLength: 150 minLength: 1 type: string required: - name type: object type: array id: format: uuid type: string is_active: description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. title: Active type: boolean is_staff: description: Designates whether the user can log into this admin site. title: Staff status type: boolean last_name: maxLength: 150 type: string password: maxLength: 128 minLength: 1 type: string writeOnly: true username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string required: - id type: object PatchedBulkWritableVLANGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - id type: object PatchedBulkWritableVLANRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: allOf: - $ref: '#/components/schemas/NestedVLANGroupRequest' nullable: true id: format: uuid type: string location: allOf: - $ref: '#/components/schemas/NestedLocationRequest' nullable: true name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedRoleRequest' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSiteRequest' nullable: true status: $ref: '#/components/schemas/VLANStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vid: maximum: 4094 minimum: 1 title: ID type: integer required: - id type: object PatchedBulkWritableVMInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedVMInterfaceRequest' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean id: format: uuid type: string mac_address: maxLength: 18 nullable: true type: string mode: $ref: '#/components/schemas/ModeEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedVMInterfaceRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: properties: name: maxLength: 64 minLength: 1 type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - name - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true virtual_machine: $ref: '#/components/schemas/NestedVirtualMachineRequest' required: - id type: object PatchedBulkWritableVRFRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enforce_unique: description: Prevent duplicate prefixes/IP addresses within this VRF title: Enforce unique space type: boolean export_targets: items: properties: name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string required: - name type: object type: array id: format: uuid type: string import_targets: items: properties: name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string required: - name type: object type: array name: maxLength: 100 minLength: 1 type: string rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true required: - id type: object PatchedBulkWritableValidatedSoftwareLCMRequest: description: REST API serializer for ValidatedSoftwareLCM records. properties: custom_fields: additionalProperties: {} type: object device_roles: items: format: uuid type: string type: array device_types: items: format: uuid type: string type: array devices: items: format: uuid type: string type: array end: format: date nullable: true title: Valid Until type: string id: format: uuid type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array preferred: title: Preferred Version type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: $ref: '#/components/schemas/NestedSoftwareLCMRequest' start: format: date title: Valid Since type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableVirtualChassisRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object domain: maxLength: 30 type: string id: format: uuid type: string master: allOf: - $ref: '#/components/schemas/NestedDeviceRequest' nullable: true name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableVirtualMachineWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster: $ref: '#/components/schemas/NestedClusterRequest' comments: type: string custom_fields: additionalProperties: {} type: object disk: maximum: 2147483647 minimum: 0 nullable: true title: Disk (GB) type: integer id: format: uuid type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchemaRequest' nullable: true memory: maximum: 2147483647 minimum: 0 nullable: true title: Memory (MB) type: integer name: maxLength: 64 minLength: 1 type: string platform: allOf: - $ref: '#/components/schemas/NestedPlatformRequest' nullable: true primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: allOf: - $ref: '#/components/schemas/NestedDeviceRoleRequest' nullable: true status: $ref: '#/components/schemas/VirtualMachineStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenantRequest' nullable: true vcpus: maximum: 32767 minimum: 0 nullable: true type: integer required: - id type: object PatchedBulkWritableVulnerabilityLCMRequest: description: REST API serializer for VulnerabilityLCM records. properties: custom_fields: additionalProperties: {} type: object id: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedBulkWritableWebhookRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: additional_headers: description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is support with the same context as the request body (below).' type: string body_template: description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.' type: string ca_file_path: description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. maxLength: 4096 nullable: true type: string content_types: items: type: string type: array http_content_type: description: The complete list of official content types is available here. maxLength: 100 minLength: 1 type: string http_method: $ref: '#/components/schemas/HttpMethodEnum' id: format: uuid type: string name: maxLength: 150 minLength: 1 type: string payload_url: description: A POST will be sent to this URL when the webhook is called. maxLength: 500 minLength: 1 title: URL type: string secret: description: When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. maxLength: 255 type: string ssl_verification: description: Enable SSL certificate verification. Disable with caution! type: boolean type_create: description: Call this webhook when a matching object is created. type: boolean type_delete: description: Call this webhook when a matching object is deleted. type: boolean type_update: description: Call this webhook when a matching object is updated. type: boolean required: - id type: object PatchedBulkWritableZoneRequest: description: Zone Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string id: format: uuid type: string interfaces: items: $ref: '#/components/schemas/NestedInterfaceRequest' type: array name: description: Name of the zone (e.g. trust) maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object PatchedCapircaPolicyRequest: description: CapircaPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object cfg: nullable: true type: string custom_fields: additionalProperties: {} type: object device: format: uuid nullable: true type: string net: nullable: true type: string pol: nullable: true type: string svc: nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedCircuitMaintenanceCircuitImpactRequest: description: Serializer for API. properties: circuit: format: uuid type: string impact: nullable: true oneOf: - $ref: '#/components/schemas/ImpactEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' maintenance: format: uuid type: string type: object PatchedCircuitMaintenanceRequest: description: Serializer for API. properties: ack: nullable: true type: boolean description: nullable: true type: string end_time: format: date-time type: string name: maxLength: 100 minLength: 1 type: string start_time: format: date-time type: string status: nullable: true oneOf: - $ref: '#/components/schemas/StatusD95Enum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' type: object PatchedCircuitTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedClusterGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedClusterTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedCommandTokenRequest: description: API serializer for interacting with CommandToken objects. properties: comment: description: 'Optional: Enter description of token' maxLength: 255 type: string platform: $ref: '#/components/schemas/PlatformEnum' token: description: Token given by chat platform for signing or command validation maxLength: 255 minLength: 1 type: string type: object PatchedComplianceFeatureRequest: description: Serializer for ComplianceFeature object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedComplianceRuleRequest: description: Serializer for ComplianceRule object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object config_ordered: description: Whether or not the configuration order matters, such as in ACLs. title: Configured Ordered type: boolean config_type: allOf: - $ref: '#/components/schemas/ConfigTypeEnum' description: Whether the config is in cli or json/structured format. custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string feature: format: uuid type: string match_config: description: The config to match that is matched based on the parent most configuration. e.g. `router bgp` or `ntp`. nullable: true title: Config to Match type: string platform: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedComputedFieldRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string description: maxLength: 200 type: string fallback_value: description: Fallback value (if any) to be output for the field in the case of a template rendering error. maxLength: 500 type: string label: description: Name of the field as displayed to users maxLength: 100 minLength: 1 type: string slug: description: Internal field name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string template: description: Jinja2 template code for field value maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer type: object PatchedConfigComplianceRequest: description: Serializer for ConfigCompliance object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object actual: additionalProperties: {} description: Actual Configuration for feature type: object compliance: nullable: true type: boolean compliance_int: maximum: 2147483647 minimum: -2147483648 nullable: true type: integer custom_fields: additionalProperties: {} type: object device: description: The device format: uuid type: string extra: additionalProperties: {} description: Configuration that should not be on the device. type: object intended: additionalProperties: {} description: Intended Configuration for feature type: object missing: additionalProperties: {} description: Configuration that should be on the device. type: object ordered: type: boolean rule: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedConfigContextSchemaRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object data_schema: additionalProperties: {} description: A JSON Schema document which is used to validate a config context object. type: object description: maxLength: 200 type: string name: maxLength: 200 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 200 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedConfigRemoveRequest: description: Serializer for ConfigRemove object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern used to remove a line from the backup configuration. maxLength: 200 minLength: 1 title: Regex Pattern type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedConfigReplaceRequest: description: Serializer for ConfigReplace object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 255 minLength: 1 type: string platform: format: uuid type: string regex: description: Regex pattern that will be found and replaced with 'replaced text'. maxLength: 200 minLength: 1 title: Regex Pattern to Substitute type: string replace: description: Text that will be inserted in place of Regex pattern match. maxLength: 200 minLength: 1 title: Replaced Text type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedCustomFieldSerializerVersion12Request: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_types: items: type: string type: array default: additionalProperties: {} description: Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo"). nullable: true type: object description: description: A helpful description for this field. maxLength: 200 type: string filter_logic: $ref: '#/components/schemas/FilterLogicEnum' label: maxLength: 50 minLength: 1 type: string name: description: Human-readable unique name of this field. maxLength: 50 minLength: 1 type: string required: description: If true, this field is required when creating new objects or editing an existing object. type: boolean slug: maxLength: 50 minLength: 1 type: string type: $ref: '#/components/schemas/CustomFieldTypeChoices' validation_maximum: description: Maximum allowed value (for numeric fields). format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true title: Maximum value type: integer validation_minimum: description: Minimum allowed value (for numeric fields). format: int64 maximum: 9223372036854775807 minimum: -9223372036854775808 nullable: true title: Minimum value type: integer validation_regex: description: Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, ^[A-Z]{3}$ will limit values to exactly three uppercase letters. Regular expression on select and multi-select will be applied at Custom Field Choices definition. maxLength: 500 type: string weight: description: Fields with higher weights appear lower in a form. maximum: 32767 minimum: 0 type: integer type: object PatchedCustomLinkRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: button_class: allOf: - $ref: '#/components/schemas/ButtonClassEnum' description: The class of the first link in a group will be used for the dropdown button content_type: type: string group_name: description: Links with the same group will appear as a dropdown menu maxLength: 50 type: string name: maxLength: 100 minLength: 1 type: string new_window: description: Force link to open in a new window type: boolean target_url: description: Jinja2 template code for link URL. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. maxLength: 500 minLength: 1 title: URL type: string text: description: Jinja2 template code for link text. Reference the object as {{ obj }} such as {{ obj.platform.slug }}. Links which render as empty text will not be displayed. maxLength: 500 minLength: 1 type: string weight: maximum: 32767 minimum: 0 type: integer type: object PatchedDeviceRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string vm_role: description: Virtual machines may be assigned to this role type: boolean type: object PatchedDynamicGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_type: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string filter: additionalProperties: {} description: A JSON-encoded dictionary of filter parameters for group membership type: object name: description: Dynamic Group name maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: description: Unique slug maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedExportTemplateRequest: description: Extend ValidatedModelSerializer with a `relationships` field. properties: content_type: type: string description: maxLength: 200 type: string file_extension: description: Extension to append to the rendered filename maxLength: 15 type: string mime_type: description: Defaults to text/plain maxLength: 50 type: string name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object template_code: description: The list of objects being exported is passed as a context variable named queryset. minLength: 1 type: string type: object PatchedGoldenConfigRequest: description: Serializer for GoldenConfig object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_config: description: Full backup config for device. type: string backup_last_attempt_date: format: date-time nullable: true type: string backup_last_success_date: format: date-time nullable: true type: string compliance_config: description: Full config diff for device. type: string compliance_last_attempt_date: format: date-time nullable: true type: string compliance_last_success_date: format: date-time nullable: true type: string custom_fields: additionalProperties: {} type: object device: description: device format: uuid type: string intended_config: description: Intended config for the device. type: string intended_last_attempt_date: format: date-time nullable: true type: string intended_last_success_date: format: date-time nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedGraphQLQueryRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: name: maxLength: 100 minLength: 1 type: string query: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string variables: additionalProperties: {} default: {} nullable: true type: object type: object PatchedGroupRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: name: maxLength: 150 minLength: 1 type: string type: object PatchedIPRangeRequest: description: IPRange Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string end_address: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start_address: minLength: 1 type: string status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array vrf: format: uuid nullable: true type: string type: object PatchedImageAttachmentRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: content_type: type: string image: format: binary type: string image_height: maximum: 32767 minimum: 0 type: integer image_width: maximum: 32767 minimum: 0 type: integer name: maxLength: 50 type: string object_id: format: uuid type: string type: object PatchedJobHookRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object enabled: type: boolean job: description: The job that this job hook will initiate format: uuid type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type_create: description: Call this job hook when a matching object is created. type: boolean type_delete: description: Call this job hook when a matching object is deleted. type: boolean type_update: description: Call this job hook when a matching object is updated. type: boolean type: object PatchedJobRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: approval_required: description: Whether the job requires approval from another user before running type: boolean approval_required_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean commit_default: description: Whether the job defaults to committing changes when run, or defaults to a dry-run type: boolean commit_default_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean custom_fields: additionalProperties: {} type: object description: description: Markdown formatting is supported type: string description_override: description: If set, the configured description will remain even if the underlying Job source code changes type: boolean enabled: description: Whether this job can be executed by users type: boolean grouping: description: Human-readable grouping that this job belongs to maxLength: 255 minLength: 1 type: string grouping_override: description: If set, the configured grouping will remain even if the underlying Job source code changes type: boolean has_sensitive_variables: description: Whether this job contains sensitive variables type: boolean has_sensitive_variables_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean hidden: description: Whether the job defaults to not being shown in the UI type: boolean hidden_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean name: description: Human-readable name of this job maxLength: 100 minLength: 1 type: string name_override: description: If set, the configured name will remain even if the underlying Job source code changes type: boolean read_only: description: Whether the job is prevented from making lasting changes to the database type: boolean read_only_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 320 pattern: ^[-a-zA-Z0-9_]+$ type: string soft_time_limit: description: Maximum runtime in seconds before the job will receive a SoftTimeLimitExceeded exception.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number soft_time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array task_queues: additionalProperties: {} description: Comma separated list of task queues that this job can run on. A blank list will use the default queue type: object task_queues_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean time_limit: description: Maximum runtime in seconds before the job will be forcibly terminated.
Set to 0 to use Nautobot system default format: double minimum: 0 type: number time_limit_override: description: If set, the configured value will remain even if the underlying Job source code changes type: boolean type: object PatchedManufacturerRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedMinMaxValidationRuleRequest: description: Serializer for `MinMaxValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string max: description: When set, apply a maximum value contraint to the value of the model field. format: double nullable: true type: number min: description: When set, apply a minimum value contraint to the value of the model field. format: double nullable: true type: number name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedNATPolicyRequest: description: NATPolicy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/NATPolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/NATPolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: object PatchedNoteRequest: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: assigned_object_id: format: uuid type: string assigned_object_type: type: string note: minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedPeeringRequest: description: REST API serializer for Peering records. properties: custom_fields: additionalProperties: {} type: object status: $ref: '#/components/schemas/CircuitStatusChoices' type: object PatchedPeeringRoleRequest: description: REST API serializer for PeeringRole records. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedPolicyRequest: description: Policy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: object PatchedProviderLCMRequest: description: API serializer. properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string email: format: email maxLength: 254 title: E-mail type: string name: maxLength: 100 minLength: 1 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedProviderRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: account: maxLength: 100 title: Account number type: string admin_contact: type: string asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string custom_fields: additionalProperties: {} type: object name: maxLength: 100 minLength: 1 type: string noc_contact: type: string portal_url: format: uri maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedRIRRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string is_private: description: IP space managed by this RIR is considered private title: Private type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedRackRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedRegularExpressionValidationRuleRequest: description: Serializer for `RegularExpressionValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string name: maxLength: 100 minLength: 1 type: string regular_expression: minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedRelationshipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string destination_filter: additionalProperties: {} description: Filterset filter matching the applicable destination objects of the selected type nullable: true type: object destination_hidden: description: Hide this relationship on the destination object. title: Hide for destination object type: boolean destination_label: description: Label for related source objects, as displayed on the destination object. maxLength: 50 type: string destination_type: type: string name: description: Name of the relationship as displayed to users maxLength: 100 minLength: 1 type: string required_on: description: Objects on the specified side MUST implement this relationship. Not permitted for symmetric relationships. oneOf: - $ref: '#/components/schemas/RequiredOnEnum' - $ref: '#/components/schemas/BlankEnum' slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string source_filter: additionalProperties: {} description: Filterset filter matching the applicable source objects of the selected type nullable: true type: object source_hidden: description: Hide this relationship on the source object. title: Hide for source object type: boolean source_label: description: Label for related destination objects, as displayed on the source object. maxLength: 50 type: string source_type: type: string type: allOf: - $ref: '#/components/schemas/RelationshipTypeChoices' description: Cardinality of this relationship type: object PatchedRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string weight: maximum: 32767 minimum: 0 type: integer type: object PatchedSecretRequest: description: Serializer for `Secret` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string parameters: additionalProperties: {} type: object provider: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedSecretsGroupRequest: description: Serializer for `SecretsGroup` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedServiceObjectRequest: description: ServiceObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: allOf: - $ref: '#/components/schemas/IpProtocolEnum' description: IANA IP Protocol (e.g. TCP UDP ICMP) name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedStatusRequest: description: Serializer for `Status` objects. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object name: maxLength: 50 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedTagSerializerVersion13Request: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 minLength: 1 pattern: ^[-\w]+$ type: string type: object PatchedTokenRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string expires: format: date-time nullable: true type: string key: maxLength: 40 minLength: 40 type: string write_enabled: description: Permit create/update/delete operations using this key type: boolean type: object PatchedUserObjectRequest: description: UserObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string type: object PatchedVulnerabilityLCMRequest: description: REST API serializer for VulnerabilityLCM records. properties: custom_fields: additionalProperties: {} type: object relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWebhookRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: additional_headers: description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is support with the same context as the request body (below).' type: string body_template: description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.' type: string ca_file_path: description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. maxLength: 4096 nullable: true type: string content_types: items: type: string type: array http_content_type: description: The complete list of official content types is available here. maxLength: 100 minLength: 1 type: string http_method: $ref: '#/components/schemas/HttpMethodEnum' name: maxLength: 150 minLength: 1 type: string payload_url: description: A POST will be sent to this URL when the webhook is called. maxLength: 500 minLength: 1 title: URL type: string secret: description: When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. maxLength: 255 type: string ssl_verification: description: Enable SSL certificate verification. Disable with caution! type: boolean type_create: description: Call this webhook when a matching object is created. type: boolean type_delete: description: Call this webhook when a matching object is deleted. type: boolean type_update: description: Call this webhook when a matching object is updated. type: boolean type: object PatchedWritableAddressFamilyRequest: description: REST API serializer for AddressFamily records. properties: afi_safi: $ref: '#/components/schemas/AfiSafiEnum' custom_fields: additionalProperties: {} type: object export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string routing_instance: format: uuid title: BGP Routing Instance type: string vrf: format: uuid nullable: true type: string type: object PatchedWritableAddressObjectGroupRequest: description: AddressObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableAddressObjectRequest: description: AddressObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: format: uuid nullable: true type: string ip_address: format: uuid nullable: true type: string ip_range: format: uuid nullable: true type: string name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableAggregateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object date_added: format: date nullable: true type: string description: maxLength: 200 type: string prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object rir: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: object PatchedWritableAutonomousSystemRequest: description: REST API serializer for AutonomousSystem records. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string provider: format: uuid nullable: true type: string status: $ref: '#/components/schemas/Status2a0Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableBGPRoutingInstanceRequest: description: REST API serializer for Peering records. properties: autonomous_system: format: uuid type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string router_id: format: uuid nullable: true type: string type: object PatchedWritableCVELCMRequest: description: REST API serializer for CVELCM records. properties: comments: type: string custom_fields: additionalProperties: {} type: object cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string fix: maxLength: 255 nullable: true type: string link: format: uri maxLength: 200 minLength: 1 type: string name: maxLength: 16 minLength: 1 type: string published_date: format: date type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object severity: $ref: '#/components/schemas/SeverityEnum' status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableCableRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object label: maxLength: 100 type: string length: maximum: 32767 minimum: 0 nullable: true type: integer length_unit: oneOf: - $ref: '#/components/schemas/LengthUnitEnum' - $ref: '#/components/schemas/BlankEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CableStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array termination_a_id: format: uuid type: string termination_a_type: type: string termination_b_id: format: uuid type: string termination_b_type: type: string type: oneOf: - $ref: '#/components/schemas/CableTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritableCircuitRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cid: maxLength: 100 minLength: 1 title: Circuit ID type: string comments: type: string commit_rate: maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string install_date: format: date nullable: true title: Date installed type: string provider: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CircuitStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: format: uuid type: string type: object PatchedWritableCircuitTerminationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: circuit: format: uuid type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location: format: uuid nullable: true type: string port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer pp_info: maxLength: 100 title: Patch panel/port(s) type: string provider_network: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string term_side: allOf: - $ref: '#/components/schemas/TermSideEnum' title: Termination upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer xconnect_id: maxLength: 50 title: Cross-connect ID type: string type: object PatchedWritableClusterRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object group: format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: format: uuid type: string type: object PatchedWritableConfigContextRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: cluster_groups: items: format: uuid type: string type: array clusters: items: format: uuid type: string type: array data: additionalProperties: {} type: object description: maxLength: 200 type: string device_types: items: format: uuid type: string type: array is_active: type: boolean locations: items: format: uuid type: string type: array name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string platforms: items: format: uuid type: string type: array regions: items: format: uuid type: string type: array roles: items: format: uuid type: string type: array schema: description: Optional schema to validate the structure of the data format: uuid nullable: true type: string sites: items: format: uuid type: string type: array tags: items: type: string type: array tenant_groups: items: format: uuid type: string type: array tenants: items: format: uuid type: string type: array weight: maximum: 32767 minimum: 0 type: integer type: object PatchedWritableConsolePortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritableConsolePortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritableConsoleServerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritableConsoleServerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritableContactLCMRequest: description: API serializer. properties: address: maxLength: 200 type: string comments: type: string contract: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object email: format: email maxLength: 254 title: Contact E-mail type: string name: maxLength: 80 minLength: 1 nullable: true type: string phone: maxLength: 20 type: string priority: maximum: 2147483647 minimum: 0 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableContractLCMRequest: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string custom_fields: additionalProperties: {} type: object end: format: date nullable: true title: Contract End Date type: string name: maxLength: 100 minLength: 1 type: string provider: format: uuid nullable: true title: Vendor type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableCustomFieldChoiceRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: field: format: uuid type: string value: maxLength: 100 minLength: 1 type: string weight: description: Higher weights appear later in the list maximum: 32767 minimum: 0 type: integer type: object PatchedWritableDeviceBayRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string installed_device: format: uuid nullable: true type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableDeviceBayTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: object PatchedWritableDeviceRedundancyGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string failover_strategy: oneOf: - $ref: '#/components/schemas/FailoverStrategyEnum' - $ref: '#/components/schemas/BlankEnum' name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableDeviceTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object front_image: format: binary type: string is_full_depth: description: Device consumes both front and rear rack faces type: boolean manufacturer: format: uuid type: string model: maxLength: 100 minLength: 1 type: string part_number: description: Discrete part number (optional) maxLength: 50 type: string rear_image: format: binary type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string subdevice_role: description: Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. oneOf: - $ref: '#/components/schemas/SubdeviceRoleEnum' - $ref: '#/components/schemas/BlankEnum' title: Parent/child status tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array u_height: maximum: 32767 minimum: 0 title: Height (U) type: integer type: object PatchedWritableDeviceWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: format: uuid nullable: true type: string comments: type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: format: uuid nullable: true type: string device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: format: uuid type: string device_type: format: uuid type: string face: oneOf: - $ref: '#/components/schemas/FaceEnum' - $ref: '#/components/schemas/BlankEnum' title: Rack face local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: description: Optional schema to validate the structure of the data format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 64 nullable: true type: string platform: format: uuid nullable: true type: string position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip4: format: uuid nullable: true title: Primary IPv4 type: string primary_ip6: format: uuid nullable: true title: Primary IPv6 type: string rack: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: format: uuid nullable: true type: string serial: maxLength: 255 title: Serial number type: string site: format: uuid type: string status: $ref: '#/components/schemas/DeviceStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: format: uuid nullable: true type: string type: object PatchedWritableDynamicGroupMembershipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: group: format: uuid type: string operator: $ref: '#/components/schemas/OperatorEnum' parent_group: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer type: object PatchedWritableFQDNRequest: description: FQDN Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableFrontPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: format: uuid type: string rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' type: object PatchedWritableFrontPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: format: uuid type: string rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' type: object PatchedWritableGitRepositoryRequest: description: Git repositories defined as a data source. properties: branch: maxLength: 64 minLength: 1 type: string current_head: description: Commit hash of the most recent fetch from the selected branch. Used for syncing between workers. maxLength: 48 type: string custom_fields: additionalProperties: {} type: object name: maxLength: 100 minLength: 1 type: string provided_contents: items: oneOf: - $ref: '#/components/schemas/ProvidedContentsEnum' - $ref: '#/components/schemas/BlankEnum' type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remote_url: description: Only HTTP and HTTPS URLs are presently supported format: uri maxLength: 255 minLength: 1 type: string secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string token: minLength: 1 type: string writeOnly: true username: maxLength: 64 type: string type: object PatchedWritableGoldenConfigSettingRequest: description: Serializer for GoldenConfigSetting object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_path_template: description: The Jinja path representation of where the backup file will be found. The variable `obj` is available as the device instance object of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Backup Path in Jinja Template Form type: string backup_repository: format: uuid nullable: true type: string backup_test_connectivity: description: Whether or not to pretest the connectivity of the device by verifying there is a resolvable IP that can connect to port 22. title: Backup Test type: boolean custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dynamic_group: format: uuid type: string intended_path_template: description: The Jinja path representation of where the generated file will be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Intended Path in Jinja Template Form type: string intended_repository: format: uuid nullable: true type: string jinja_path_template: description: The Jinja path representation of where the Jinja template can be found. e.g. `{{obj.platform.slug}}.j2` maxLength: 255 title: Template Path in Jinja Template Form type: string jinja_repository: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string scope: additionalProperties: {} type: object slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string sot_agg_query: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array weight: maximum: 32767 minimum: 0 type: integer type: object PatchedWritableHardwareLCMRequest: description: API serializer. properties: custom_fields: additionalProperties: {} type: object device_type: format: uuid nullable: true type: string documentation_url: format: uri maxLength: 200 type: string end_of_sale: format: date nullable: true type: string end_of_security_patches: format: date nullable: true type: string end_of_support: format: date nullable: true type: string end_of_sw_releases: format: date nullable: true title: End of Software Releases type: string inventory_item: maxLength: 255 nullable: true title: Inventory Item Part type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableIPAddressRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: address: minLength: 1 type: string assigned_object_id: format: uuid nullable: true type: string assigned_object_type: nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dns_name: description: Hostname or FQDN (not case-sensitive) maxLength: 255 pattern: ^[0-9A-Za-z._-]+$ type: string nat_inside: description: The IP Addresses for which this address is the "outside" IP format: uuid nullable: true title: NAT (Inside) type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: description: The functional role of this IP oneOf: - $ref: '#/components/schemas/RoleEnum' - $ref: '#/components/schemas/BlankEnum' status: $ref: '#/components/schemas/IPAddressStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vrf: format: uuid nullable: true type: string type: object PatchedWritableInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: description: Assigned bridge interface format: uuid nullable: true title: Bridge interface type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string enabled: type: boolean label: description: Physical label maxLength: 64 type: string lag: description: Assigned LAG interface format: uuid nullable: true title: Parent LAG type: string mac_address: maxLength: 18 nullable: true type: string mgmt_only: description: This interface is used only for out-of-band management title: Management only type: boolean mode: oneOf: - $ref: '#/components/schemas/ModeEnum' - $ref: '#/components/schemas/BlankEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: description: Assigned parent interface format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: format: uuid title: Tagged VLANs type: string type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/InterfaceTypeChoices' untagged_vlan: format: uuid nullable: true type: string type: object PatchedWritableInterfaceTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string mgmt_only: title: Management only type: boolean name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/InterfaceTypeChoices' type: object PatchedWritableInventoryItemRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this item maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string discovered: description: This item was automatically discovered type: boolean label: description: Physical label maxLength: 64 type: string manufacturer: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string parent: format: uuid nullable: true type: string part_id: description: Manufacturer-assigned part identifier maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object serial: maxLength: 255 title: Serial number type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableLocationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location_type: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: object PatchedWritableLocationTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string nestable: description: Allow Locations of this type to be parents/children of other Locations of this same type type: boolean parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedWritableNATPolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/ZoneRequest' index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remark: type: boolean request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableObjectPermissionRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: actions: additionalProperties: {} description: The list of actions granted by this permission type: object constraints: additionalProperties: {} description: Queryset filter matching the applicable objects of the selected type(s) nullable: true type: object description: maxLength: 200 type: string enabled: type: boolean groups: items: type: integer type: array name: maxLength: 100 minLength: 1 type: string object_types: items: type: string type: array users: items: format: uuid type: string type: array type: object PatchedWritablePeerEndpointRequest: description: REST API serializer for PeerEndpoint records. properties: autonomous_system: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object enabled: type: boolean export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string peer: format: uuid nullable: true type: string peer_group: format: uuid nullable: true type: string peering: format: uuid type: string routing_instance: format: uuid nullable: true title: BGP Routing Instance type: string secret: format: uuid nullable: true type: string source_interface: format: uuid nullable: true type: string source_ip: format: uuid nullable: true title: BGP Peer IP type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritablePeerGroupRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string routing_instance: format: uuid type: string secret: format: uuid nullable: true type: string source_interface: format: uuid nullable: true type: string source_ip: format: uuid nullable: true title: Source IP Address type: string template: format: uuid nullable: true type: string type: object PatchedWritablePeerGroupTemplateRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string secret: format: uuid nullable: true type: string type: object PatchedWritablePlatformRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string manufacturer: description: Optionally limit this platform to devices of a certain manufacturer format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string napalm_args: additionalProperties: {} description: Additional arguments to pass when initiating the NAPALM driver (JSON format) nullable: true title: NAPALM arguments type: object napalm_driver: description: The name of the NAPALM driver to use when interacting with devices maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedWritablePolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object action: $ref: '#/components/schemas/ActionEnum' custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/ZoneRequest' index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritablePowerFeedRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: amperage: maximum: 32767 minimum: 1 type: integer comments: type: string custom_fields: additionalProperties: {} type: object max_utilization: description: Maximum permissible draw (percentage) maximum: 100 minimum: 1 type: integer name: maxLength: 100 minLength: 1 type: string phase: $ref: '#/components/schemas/PhaseEnum' power_panel: format: uuid type: string rack: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/PowerFeedStatusChoices' supply: $ref: '#/components/schemas/SupplyEnum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PowerFeedTypeChoices' voltage: maximum: 32767 minimum: -32768 type: integer type: object PatchedWritablePowerOutletRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string feed_leg: description: Phase (for three-phase feeds) oneOf: - $ref: '#/components/schemas/FeedLegEnum' - $ref: '#/components/schemas/BlankEnum' label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/PowerOutletTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritablePowerOutletTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string feed_leg: description: Phase (for three-phase feeds) oneOf: - $ref: '#/components/schemas/FeedLegEnum' - $ref: '#/components/schemas/BlankEnum' label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/PowerOutletTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritablePowerPanelRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string rack_group: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritablePowerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/PowerPortTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritablePowerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/PowerPortTypeChoices' - $ref: '#/components/schemas/BlankEnum' type: object PatchedWritablePrefixRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string is_pool: description: All IP addresses within this prefix are considered usable title: Is a pool type: boolean location: format: uuid nullable: true type: string prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: description: The primary function of this prefix format: uuid nullable: true type: string site: format: uuid nullable: true type: string status: $ref: '#/components/schemas/PrefixStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vlan: format: uuid nullable: true type: string vrf: format: uuid nullable: true type: string type: object PatchedWritableProviderNetworkRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string provider: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableRackGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedWritableRackRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this rack maxLength: 50 nullable: true type: string comments: type: string custom_fields: additionalProperties: {} type: object desc_units: description: Units are numbered top-to-bottom title: Descending units type: boolean facility_id: description: Locally-assigned identifier maxLength: 50 nullable: true type: string group: description: Assigned group format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string outer_depth: description: Outer dimension of rack (depth) maximum: 32767 minimum: 0 nullable: true type: integer outer_unit: oneOf: - $ref: '#/components/schemas/OuterUnitEnum' - $ref: '#/components/schemas/BlankEnum' outer_width: description: Outer dimension of rack (width) maximum: 32767 minimum: 0 nullable: true type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: description: Functional role format: uuid nullable: true type: string serial: maxLength: 255 title: Serial number type: string site: format: uuid type: string status: $ref: '#/components/schemas/RackStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: oneOf: - $ref: '#/components/schemas/RackTypeChoices' - $ref: '#/components/schemas/BlankEnum' u_height: description: Height in rack units maximum: 100 minimum: 1 title: Height (U) type: integer width: allOf: - $ref: '#/components/schemas/WidthEnum' description: Rail-to-rail width maximum: 32767 minimum: 0 type: object PatchedWritableRackReservationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 minLength: 1 type: string rack: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string units: additionalProperties: {} type: object user: format: uuid type: string type: object PatchedWritableRearPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' type: object PatchedWritableRearPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' type: object PatchedWritableRegionRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedWritableRelationshipAssociationRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: destination_id: format: uuid type: string destination_type: type: string relationship: format: uuid type: string source_id: format: uuid type: string source_type: type: string type: object PatchedWritableRouteTargetRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: object PatchedWritableSecretsGroupAssociationRequest: description: Serializer for `SecretsGroupAssociation` objects. properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' group: format: uuid type: string secret: format: uuid type: string secret_type: $ref: '#/components/schemas/SecretTypeEnum' type: object PatchedWritableServiceObjectGroupRequest: description: ServiceObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableServiceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid nullable: true type: string ipaddresses: items: format: uuid title: IP addresses type: string title: IP addresses type: array name: maxLength: 100 minLength: 1 type: string ports: items: maximum: 65535 minimum: 1 type: integer type: array protocol: $ref: '#/components/schemas/ProtocolEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array virtual_machine: format: uuid nullable: true type: string type: object PatchedWritableSiteRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string contact_email: format: email maxLength: 254 title: Contact E-mail type: string contact_name: maxLength: 50 type: string contact_phone: maxLength: 20 type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string facility: description: Local facility ID or description maxLength: 50 type: string latitude: description: GPS coordinate (latitude) format: decimal nullable: true pattern: ^-?\d{0,2}(?:\.\d{0,6})?$ type: string longitude: description: GPS coordinate (longitude) format: decimal nullable: true pattern: ^-?\d{0,3}(?:\.\d{0,6})?$ type: string name: maxLength: 100 minLength: 1 type: string physical_address: maxLength: 200 type: string region: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object shipping_address: maxLength: 200 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string time_zone: nullable: true type: string type: object PatchedWritableSoftwareImageLCMRequest: description: REST API serializer for SoftwareImageLCM records. properties: custom_fields: additionalProperties: {} type: object default_image: type: boolean device_types: items: format: uuid type: string type: array download_url: format: uri maxLength: 200 type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 minLength: 1 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: format: uuid title: Software Version type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableSoftwareLCMRequest: description: REST API serializer for SoftwareLCM records. properties: alias: maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object device_platform: format: uuid type: string documentation_url: format: uri maxLength: 200 type: string end_of_support: format: date nullable: true title: End of Software Support type: string long_term_support: type: boolean pre_release: type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string software_images: items: format: uuid type: string type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array version: maxLength: 50 minLength: 1 type: string type: object PatchedWritableTenantGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedWritableTenantRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableUserObjectGroupRequest: description: UserObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableUserRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: date_joined: format: date-time type: string email: format: email maxLength: 254 title: Email address type: string first_name: maxLength: 150 type: string groups: description: The groups this user belongs to. A user will get all permissions granted to each of their groups. items: type: integer type: array is_active: description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. title: Active type: boolean is_staff: description: Designates whether the user can log into this admin site. title: Staff status type: boolean last_name: maxLength: 150 type: string password: maxLength: 128 minLength: 1 type: string writeOnly: true username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string type: object PatchedWritableVLANGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string type: object PatchedWritableVLANRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: format: uuid nullable: true type: string site: format: uuid nullable: true type: string status: $ref: '#/components/schemas/VLANStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer type: object PatchedWritableVMInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: description: Assigned bridge interface format: uuid nullable: true title: Bridge interface type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean mac_address: maxLength: 18 nullable: true type: string mode: oneOf: - $ref: '#/components/schemas/ModeEnum' - $ref: '#/components/schemas/BlankEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: description: Assigned parent interface format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: format: uuid title: Tagged VLANs type: string type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array untagged_vlan: format: uuid nullable: true type: string virtual_machine: format: uuid type: string type: object PatchedWritableVRFRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enforce_unique: description: Prevent duplicate prefixes/IP addresses within this VRF title: Enforce unique space type: boolean export_targets: items: format: uuid type: string type: array import_targets: items: format: uuid type: string type: array name: maxLength: 100 minLength: 1 type: string rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: object PatchedWritableValidatedSoftwareLCMRequest: description: REST API serializer for ValidatedSoftwareLCM records. properties: custom_fields: additionalProperties: {} type: object device_roles: items: format: uuid type: string type: array device_types: items: format: uuid type: string type: array devices: items: format: uuid type: string type: array end: format: date nullable: true title: Valid Until type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array preferred: title: Preferred Version type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: format: uuid title: Software Version type: string start: format: date title: Valid Since type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableVirtualChassisRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object domain: maxLength: 30 type: string master: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PatchedWritableVirtualMachineWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster: format: uuid type: string comments: type: string custom_fields: additionalProperties: {} type: object disk: maximum: 2147483647 minimum: 0 nullable: true title: Disk (GB) type: integer local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: description: Optional schema to validate the structure of the data format: uuid nullable: true type: string memory: maximum: 2147483647 minimum: 0 nullable: true title: Memory (MB) type: integer name: maxLength: 64 minLength: 1 type: string platform: format: uuid nullable: true type: string primary_ip4: format: uuid nullable: true title: Primary IPv4 type: string primary_ip6: format: uuid nullable: true title: Primary IPv6 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: format: uuid nullable: true type: string status: $ref: '#/components/schemas/VirtualMachineStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vcpus: maximum: 32767 minimum: 0 nullable: true type: integer type: object PatchedZoneRequest: description: Zone Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string interfaces: items: $ref: '#/components/schemas/NestedInterfaceRequest' type: array name: description: Name of the zone (e.g. trust) maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object PeerEndpoint: description: REST API serializer for PeerEndpoint records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystem' nullable: true created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid readOnly: true type: string import_policy: maxLength: 100 type: string last_updated: format: date-time nullable: true readOnly: true type: string peer: allOf: - $ref: '#/components/schemas/NestedPeerEndpoint' nullable: true peer_group: allOf: - $ref: '#/components/schemas/NestedPeerGroup' nullable: true peering: allOf: - $ref: '#/components/schemas/NestedPeering' nullable: true routing_instance: allOf: - $ref: '#/components/schemas/NestedRoutingInstance' nullable: true secret: allOf: - $ref: '#/components/schemas/NestedSecret' nullable: true source_interface: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true source_ip: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - peering - url type: object PeerGroup: description: REST API serializer for PeerGroup records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystem' nullable: true created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string enabled: type: boolean export_policy: maxLength: 100 type: string extra_attributes: readOnly: true type: string id: format: uuid readOnly: true type: string import_policy: maxLength: 100 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string role: format: uuid nullable: true type: string routing_instance: $ref: '#/components/schemas/NestedRoutingInstance' secret: allOf: - $ref: '#/components/schemas/NestedSecret' nullable: true source_interface: allOf: - $ref: '#/components/schemas/NestedInterface' nullable: true source_ip: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true template: allOf: - $ref: '#/components/schemas/NestedPeerGroupTemplate' nullable: true url: format: uri readOnly: true type: string required: - created - display - extra_attributes - id - last_updated - name - routing_instance - url type: object PeerGroupTemplate: description: REST API serializer for PeerGroup records. properties: autonomous_system: allOf: - $ref: '#/components/schemas/NestedAutonomousSystem' nullable: true created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string enabled: type: boolean export_policy: maxLength: 100 type: string id: format: uuid readOnly: true type: string import_policy: maxLength: 100 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string role: format: uuid nullable: true type: string secret: allOf: - $ref: '#/components/schemas/NestedSecret' nullable: true url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - url type: object Peering: description: REST API serializer for Peering records. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string endpoints: items: $ref: '#/components/schemas/NestedPeerEndpoint' type: array id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Deprovisioning - Offline - Planned - Provisioning type: string value: enum: - active - decommissioned - deprovisioning - offline - planned - provisioning type: string type: object url: format: uri readOnly: true type: string required: - created - display - id - last_updated - status - url type: object PeeringRequest: description: REST API serializer for Peering records. properties: custom_fields: additionalProperties: {} type: object status: $ref: '#/components/schemas/CircuitStatusChoices' required: - status type: object PeeringRole: description: REST API serializer for PeeringRole records. properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - url type: object PeeringRoleRequest: description: REST API serializer for PeeringRole records. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object PhaseEnum: enum: - single-phase - three-phase type: string Platform: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string manufacturer: allOf: - $ref: '#/components/schemas/NestedManufacturer' nullable: true name: maxLength: 100 type: string napalm_args: additionalProperties: {} description: Additional arguments to pass when initiating the NAPALM driver (JSON format) nullable: true title: NAPALM arguments type: object napalm_driver: description: The name of the NAPALM driver to use when interacting with devices maxLength: 50 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer required: - created - device_count - display - id - last_updated - name - notes_url - url - virtualmachine_count type: object PlatformEnum: enum: - mattermost type: string Policy: description: Policy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/PolicyDeviceM2MNested' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/PolicyDynamicGroupM2MNested' type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string policy_rules: items: format: uuid type: string readOnly: true type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: format: uuid nullable: true type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - policy_rules - url type: object PolicyDeviceM2MNested: description: PolicyDeviceM2M NestedSerializer. properties: device: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - device type: object PolicyDeviceM2MNestedRequest: description: PolicyDeviceM2M NestedSerializer. properties: device: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PolicyDynamicGroupM2MNested: description: PolicyDynamicGroupM2M NestedSerializer. properties: dynamic_group: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - dynamic_group type: object PolicyDynamicGroupM2MNestedRequest: description: PolicyDynamicGroupM2M NestedSerializer. properties: dynamic_group: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - id type: object PolicyRequest: description: Policy Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object assigned_devices: items: $ref: '#/components/schemas/PolicyDeviceM2MNestedRequest' type: array assigned_dynamic_groups: items: $ref: '#/components/schemas/PolicyDynamicGroupM2MNestedRequest' type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - name type: object PolicyRule: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object action: $ref: '#/components/schemas/ActionEnum' created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array destination_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array destination_service_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array destination_services: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array destination_zone: $ref: '#/components/schemas/Zone' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string index: maximum: 32767 minimum: 0 nullable: true type: integer last_updated: format: date-time nullable: true readOnly: true type: string log: type: boolean name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string request_id: maxLength: 100 nullable: true type: string source_address_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object address_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for a group address objects. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array source_addresses: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string fqdn: $ref: '#/components/schemas/NestedFQDN' id: format: uuid readOnly: true type: string ip_address: $ref: '#/components/schemas/NestedIPAddress' ip_range: $ref: '#/components/schemas/NestedIPRange' last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name descriptor for an address object type. maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix: $ref: '#/components/schemas/NestedPrefix' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object type: array source_service_groups: items: format: uuid type: string readOnly: true type: array source_services: items: format: uuid type: string readOnly: true type: array source_user_groups: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string user_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 type: string required: - created - display - id - last_updated - notes_url - url - username type: object type: array required: - created - display - id - last_updated - name - notes_url - url type: object type: array source_users: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 type: string required: - created - display - id - last_updated - notes_url - url - username type: object type: array source_zone: $ref: '#/components/schemas/Zone' status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - action - created - display - id - last_updated - name - notes_url - source_service_groups - source_services - url type: object PortTypeChoices: enum: - 8p8c - 8p6c - 8p4c - 8p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - mrj21 - fc - lc - lc-apc - lsh - lsh-apc - mpo - mtrj - sc - sc-apc - st - cs - sn - urm-p2 - urm-p4 - urm-p8 - splice type: string PowerFeed: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: amperage: maximum: 32767 minimum: 1 type: integer cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string comments: type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string max_utilization: description: Maximum permissible draw (percentage) maximum: 100 minimum: 1 type: integer name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string phase: default: label: Single phase value: single-phase properties: label: enum: - Single phase - Three-phase type: string value: enum: - single-phase - three-phase type: string type: object power_panel: $ref: '#/components/schemas/NestedPowerPanel' rack: allOf: - $ref: '#/components/schemas/NestedRack' nullable: true status: properties: label: enum: - Active - Failed - Offline - Planned type: string value: enum: - active - failed - offline - planned type: string type: object supply: default: label: AC value: ac properties: label: enum: - AC - DC type: string value: enum: - ac - dc type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: default: label: Primary value: primary properties: label: enum: - Primary - Redundant type: string value: enum: - primary - redundant type: string type: object url: format: uri readOnly: true type: string voltage: maximum: 32767 minimum: -32768 type: integer required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - created - display - id - last_updated - name - notes_url - power_panel - status - url type: object PowerFeedStatusChoices: enum: - active - failed - offline - planned type: string PowerFeedTypeChoices: enum: - primary - redundant type: string PowerOutlet: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string feed_leg: properties: label: enum: - A - B - C type: string value: enum: - A - B - C type: string type: object id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string power_port: $ref: '#/components/schemas/NestedPowerPort' tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - C5 - C7 - C13 - C15 - C19 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - NEMA 1-15R - NEMA 5-15R - NEMA 5-20R - NEMA 5-30R - NEMA 5-50R - NEMA 6-15R - NEMA 6-20R - NEMA 6-30R - NEMA 6-50R - NEMA 10-30R - NEMA 10-50R - NEMA 14-20R - NEMA 14-30R - NEMA 14-50R - NEMA 14-60R - NEMA 15-15R - NEMA 15-20R - NEMA 15-30R - NEMA 15-50R - NEMA 15-60R - NEMA L1-15R - NEMA L5-15R - NEMA L5-20R - NEMA L5-30R - NEMA L5-50R - NEMA L6-15R - NEMA L6-20R - NEMA L6-30R - NEMA L6-50R - NEMA L10-30R - NEMA L14-20R - NEMA L14-30R - NEMA L14-50R - NEMA L14-60R - NEMA L15-20R - NEMA L15-30R - NEMA L15-50R - NEMA L15-60R - NEMA L21-20R - NEMA L21-30R - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ITA Type E (CEE7/5) - ITA Type F (CEE7/3) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - USB Type A - USB Micro B - USB Type C - HDOT Cx type: string value: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c19 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-micro-b - usb-c - hdot-cx type: string type: object url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - created - device - display - id - last_updated - name - notes_url - url type: object PowerOutletTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string feed_leg: properties: label: enum: - A - B - C type: string value: enum: - A - B - C type: string type: object id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string power_port: $ref: '#/components/schemas/NestedPowerPortTemplate' type: properties: label: enum: - C5 - C7 - C13 - C15 - C19 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - NEMA 1-15R - NEMA 5-15R - NEMA 5-20R - NEMA 5-30R - NEMA 5-50R - NEMA 6-15R - NEMA 6-20R - NEMA 6-30R - NEMA 6-50R - NEMA 10-30R - NEMA 10-50R - NEMA 14-20R - NEMA 14-30R - NEMA 14-50R - NEMA 14-60R - NEMA 15-15R - NEMA 15-20R - NEMA 15-30R - NEMA 15-50R - NEMA 15-60R - NEMA L1-15R - NEMA L5-15R - NEMA L5-20R - NEMA L5-30R - NEMA L5-50R - NEMA L6-15R - NEMA L6-20R - NEMA L6-30R - NEMA L6-50R - NEMA L10-30R - NEMA L14-20R - NEMA L14-30R - NEMA L14-50R - NEMA L14-60R - NEMA L15-20R - NEMA L15-30R - NEMA L15-50R - NEMA L15-60R - NEMA L21-20R - NEMA L21-30R - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ITA Type E (CEE7/5) - ITA Type F (CEE7/3) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - USB Type A - USB Micro B - USB Type C - HDOT Cx type: string value: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c19 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-micro-b - usb-c - hdot-cx type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - url type: object PowerOutletTypeChoices: enum: - iec-60320-c5 - iec-60320-c7 - iec-60320-c13 - iec-60320-c15 - iec-60320-c19 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - nema-1-15r - nema-5-15r - nema-5-20r - nema-5-30r - nema-5-50r - nema-6-15r - nema-6-20r - nema-6-30r - nema-6-50r - nema-10-30r - nema-10-50r - nema-14-20r - nema-14-30r - nema-14-50r - nema-14-60r - nema-15-15r - nema-15-20r - nema-15-30r - nema-15-50r - nema-15-60r - nema-l1-15r - nema-l5-15r - nema-l5-20r - nema-l5-30r - nema-l5-50r - nema-l6-15r - nema-l6-20r - nema-l6-30r - nema-l6-50r - nema-l10-30r - nema-l14-20r - nema-l14-30r - nema-l14-50r - nema-l14-60r - nema-l15-20r - nema-l15-30r - nema-l15-50r - nema-l15-60r - nema-l21-20r - nema-l21-30r - CS6360C - CS6364C - CS8164C - CS8264C - CS8364C - CS8464C - ita-e - ita-f - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-micro-b - usb-c - hdot-cx type: string PowerPanel: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string powerfeed_count: readOnly: true type: integer rack_group: allOf: - $ref: '#/components/schemas/NestedRackGroup' nullable: true site: $ref: '#/components/schemas/NestedSite' tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - powerfeed_count - site - url type: object PowerPort: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string connected_endpoint: additionalProperties: {} nullable: true readOnly: true type: object connected_endpoint_reachable: nullable: true readOnly: true type: boolean connected_endpoint_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - C6 - C8 - C14 - C16 - C20 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - NEMA 1-15P - NEMA 5-15P - NEMA 5-20P - NEMA 5-30P - NEMA 5-50P - NEMA 6-15P - NEMA 6-20P - NEMA 6-30P - NEMA 6-50P - NEMA 10-30P - NEMA 10-50P - NEMA 14-20P - NEMA 14-30P - NEMA 14-50P - NEMA 14-60P - NEMA 15-15P - NEMA 15-20P - NEMA 15-30P - NEMA 15-50P - NEMA 15-60P - NEMA L1-15P - NEMA L5-15P - NEMA L5-20P - NEMA L5-30P - NEMA L5-50P - NEMA L6-15P - NEMA L6-20P - NEMA L6-30P - NEMA L6-50P - NEMA L10-30P - NEMA L14-20P - NEMA L14-30P - NEMA L14-50P - NEMA L14-60P - NEMA L15-20P - NEMA L15-30P - NEMA L15-50P - NEMA L15-60P - NEMA L21-20P - NEMA L21-30P - CS6361C - CS6365C - CS8165C - CS8265C - CS8365C - CS8465C - ITA Type E (CEE 7/5) - ITA Type F (CEE 7/4) - ITA Type E/F (CEE 7/7) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB 3.0 Type B - USB 3.0 Micro B type: string value: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c20 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-3-b - usb-3-micro-b type: string type: object url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - connected_endpoint - connected_endpoint_reachable - connected_endpoint_type - created - device - display - id - last_updated - name - notes_url - url type: object PowerPortTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 type: string type: properties: label: enum: - C6 - C8 - C14 - C16 - C20 - P+N+E 4H - P+N+E 6H - P+N+E 9H - 2P+E 4H - 2P+E 6H - 2P+E 9H - 3P+E 4H - 3P+E 6H - 3P+E 9H - 3P+N+E 4H - 3P+N+E 6H - 3P+N+E 9H - NEMA 1-15P - NEMA 5-15P - NEMA 5-20P - NEMA 5-30P - NEMA 5-50P - NEMA 6-15P - NEMA 6-20P - NEMA 6-30P - NEMA 6-50P - NEMA 10-30P - NEMA 10-50P - NEMA 14-20P - NEMA 14-30P - NEMA 14-50P - NEMA 14-60P - NEMA 15-15P - NEMA 15-20P - NEMA 15-30P - NEMA 15-50P - NEMA 15-60P - NEMA L1-15P - NEMA L5-15P - NEMA L5-20P - NEMA L5-30P - NEMA L5-50P - NEMA L6-15P - NEMA L6-20P - NEMA L6-30P - NEMA L6-50P - NEMA L10-30P - NEMA L14-20P - NEMA L14-30P - NEMA L14-50P - NEMA L14-60P - NEMA L15-20P - NEMA L15-30P - NEMA L15-50P - NEMA L15-60P - NEMA L21-20P - NEMA L21-30P - CS6361C - CS6365C - CS8165C - CS8265C - CS8365C - CS8465C - ITA Type E (CEE 7/5) - ITA Type F (CEE 7/4) - ITA Type E/F (CEE 7/7) - ITA Type G (BS 1363) - ITA Type H - ITA Type I - ITA Type J - ITA Type K - ITA Type L (CEI 23-50) - ITA Type M (BS 546) - ITA Type N - ITA Type O - USB Type A - USB Type B - USB Type C - USB Mini A - USB Mini B - USB Micro A - USB Micro B - USB 3.0 Type B - USB 3.0 Micro B type: string value: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c20 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-3-b - usb-3-micro-b type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - url type: object PowerPortTypeChoices: enum: - iec-60320-c6 - iec-60320-c8 - iec-60320-c14 - iec-60320-c16 - iec-60320-c20 - iec-60309-p-n-e-4h - iec-60309-p-n-e-6h - iec-60309-p-n-e-9h - iec-60309-2p-e-4h - iec-60309-2p-e-6h - iec-60309-2p-e-9h - iec-60309-3p-e-4h - iec-60309-3p-e-6h - iec-60309-3p-e-9h - iec-60309-3p-n-e-4h - iec-60309-3p-n-e-6h - iec-60309-3p-n-e-9h - nema-1-15p - nema-5-15p - nema-5-20p - nema-5-30p - nema-5-50p - nema-6-15p - nema-6-20p - nema-6-30p - nema-6-50p - nema-10-30p - nema-10-50p - nema-14-20p - nema-14-30p - nema-14-50p - nema-14-60p - nema-15-15p - nema-15-20p - nema-15-30p - nema-15-50p - nema-15-60p - nema-l1-15p - nema-l5-15p - nema-l5-20p - nema-l5-30p - nema-l5-50p - nema-l6-15p - nema-l6-20p - nema-l6-30p - nema-l6-50p - nema-l10-30p - nema-l14-20p - nema-l14-30p - nema-l14-50p - nema-l14-60p - nema-l15-20p - nema-l15-30p - nema-l15-50p - nema-l15-60p - nema-l21-20p - nema-l21-30p - cs6361c - cs6365c - cs8165c - cs8265c - cs8365c - cs8465c - ita-e - ita-f - ita-ef - ita-g - ita-h - ita-i - ita-j - ita-k - ita-l - ita-m - ita-n - ita-o - usb-a - usb-b - usb-c - usb-mini-a - usb-mini-b - usb-micro-a - usb-micro-b - usb-3-b - usb-3-micro-b type: string Prefix: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string family: properties: label: enum: - IPv4 - IPv6 type: string value: enum: - 4 - 6 type: integer readOnly: true type: object id: format: uuid readOnly: true type: string is_pool: description: All IP addresses within this prefix are considered usable title: Is a pool type: boolean last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true notes_url: format: uri readOnly: true type: string prefix: type: string role: allOf: - $ref: '#/components/schemas/NestedRole' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSite' nullable: true status: properties: label: enum: - Active - Container - Deprecated - Peer-to-Peer - Reserved type: string value: enum: - active - container - deprecated - p2p - reserved type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vlan: allOf: - $ref: '#/components/schemas/NestedVLAN' nullable: true vrf: allOf: - $ref: '#/components/schemas/NestedVRF' nullable: true required: - created - display - family - id - last_updated - notes_url - prefix - status - url type: object PrefixLengthRequest: properties: prefix_length: type: integer required: - prefix_length type: object PrefixStatusChoices: enum: - active - container - deprecated - p2p - reserved type: string ProtocolEnum: enum: - tcp - udp type: string ProvidedContentsEnum: enum: - extras.configcontext - extras.configcontextschema - extras.exporttemplate - extras.job - nautobot_golden_config.backupconfigs - nautobot_golden_config.intendedconfigs - nautobot_golden_config.jinjatemplate - nautobot_golden_config.pluginproperties type: string Provider: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: account: maxLength: 100 title: Account number type: string admin_contact: type: string asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer circuit_count: readOnly: true type: integer comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string noc_contact: type: string notes_url: format: uri readOnly: true type: string portal_url: format: uri maxLength: 200 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - circuit_count - created - display - id - last_updated - name - notes_url - url type: object ProviderLCM: description: API serializer. properties: comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string email: format: email maxLength: 254 title: E-mail type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - url type: object ProviderLCMRequest: description: API serializer. properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string email: format: email maxLength: 254 title: E-mail type: string name: maxLength: 100 minLength: 1 type: string phone: maxLength: 20 type: string physical_address: maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object ProviderNetwork: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string provider: $ref: '#/components/schemas/NestedProvider' slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - provider - url type: object ProviderRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: account: maxLength: 100 title: Account number type: string admin_contact: type: string asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string custom_fields: additionalProperties: {} type: object name: maxLength: 100 minLength: 1 type: string noc_contact: type: string portal_url: format: uri maxLength: 200 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object RIR: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: aggregate_count: readOnly: true type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string is_private: description: IP space managed by this RIR is considered private title: Private type: boolean last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - aggregate_count - created - display - id - last_updated - name - notes_url - url type: object RIRRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string is_private: description: IP space managed by this RIR is considered private title: Private type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object Rack: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this rack maxLength: 50 nullable: true type: string comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object desc_units: description: Units are numbered top-to-bottom title: Descending units type: boolean device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string facility_id: description: Locally-assigned identifier maxLength: 50 nullable: true type: string group: allOf: - $ref: '#/components/schemas/NestedRackGroup' nullable: true id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string outer_depth: description: Outer dimension of rack (depth) maximum: 32767 minimum: 0 nullable: true type: integer outer_unit: properties: label: enum: - Millimeters - Inches type: string value: enum: - mm - in type: string type: object outer_width: description: Outer dimension of rack (width) maximum: 32767 minimum: 0 nullable: true type: integer powerfeed_count: readOnly: true type: integer role: allOf: - $ref: '#/components/schemas/NestedRackRole' nullable: true serial: maxLength: 255 title: Serial number type: string site: $ref: '#/components/schemas/NestedSite' status: properties: label: enum: - Active - Available - Deprecated - Planned - Reserved type: string value: enum: - active - available - deprecated - planned - reserved type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true type: properties: label: enum: - 2-post frame - 4-post frame - 4-post cabinet - Wall-mounted frame - Wall-mounted cabinet type: string value: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-cabinet type: string type: object u_height: description: Height in rack units maximum: 100 minimum: 1 title: Height (U) type: integer url: format: uri readOnly: true type: string width: properties: label: enum: - 10 inches - 19 inches - 21 inches - 23 inches type: string value: enum: - 10 - 19 - 21 - 23 type: integer type: object required: - created - device_count - display - id - last_updated - name - notes_url - powerfeed_count - site - status - url type: object RackGroup: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: _depth: readOnly: true title: ' depth' type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/NestedRackGroup' nullable: true rack_count: readOnly: true type: integer site: $ref: '#/components/schemas/NestedSite' slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - _depth - created - display - id - last_updated - name - notes_url - rack_count - site - url type: object RackReservation: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string notes_url: format: uri readOnly: true type: string rack: $ref: '#/components/schemas/NestedRack' tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true units: additionalProperties: {} type: object url: format: uri readOnly: true type: string user: $ref: '#/components/schemas/NestedUser' required: - created - description - display - id - last_updated - notes_url - rack - units - url - user type: object RackRole: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string rack_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - rack_count - url type: object RackRoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object RackStatusChoices: enum: - active - available - deprecated - planned - reserved type: string RackTypeChoices: enum: - 2-post-frame - 4-post-frame - 4-post-cabinet - wall-frame - wall-cabinet type: string RackUnit: description: A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database. properties: device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true face: properties: label: enum: - Front - Rear type: string value: enum: - front - rear type: string readOnly: true type: object id: readOnly: true type: integer name: readOnly: true type: string occupied: readOnly: true type: boolean required: - device - face - id - name - occupied type: object RearPort: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cable: allOf: - $ref: '#/components/schemas/NestedCable' readOnly: true cable_peer: additionalProperties: {} nullable: true readOnly: true type: object cable_peer_type: nullable: true readOnly: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: $ref: '#/components/schemas/NestedDevice' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string positions: maximum: 1024 minimum: 1 type: integer tags: items: $ref: '#/components/schemas/TagSerializerField' type: array type: properties: label: enum: - 8P8C - 8P6C - 8P4C - 8P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - MRJ21 - FC - LC - LC/APC - LSH - LSH/APC - MPO - MTRJ - SC - SC/APC - ST - CS - SN - URM-P2 - URM-P4 - URM-P8 - Splice type: string value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - mrj21 - fc - lc - lc-apc - lsh - lsh-apc - mpo - mtrj - sc - sc-apc - st - cs - sn - urm-p2 - urm-p4 - urm-p8 - splice type: string type: object url: format: uri readOnly: true type: string required: - cable - cable_peer - cable_peer_type - created - device - display - id - last_updated - name - notes_url - type - url type: object RearPortTemplate: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: $ref: '#/components/schemas/NestedDeviceType' display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string label: description: Physical label maxLength: 64 type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 64 type: string positions: maximum: 1024 minimum: 1 type: integer type: properties: label: enum: - 8P8C - 8P6C - 8P4C - 8P2C - GG45 - TERA 4P - TERA 2P - TERA 1P - 110 Punch - BNC - MRJ21 - FC - LC - LC/APC - LSH - LSH/APC - MPO - MTRJ - SC - SC/APC - ST - CS - SN - URM-P2 - URM-P4 - URM-P8 - Splice type: string value: enum: - 8p8c - 8p6c - 8p4c - 8p2c - gg45 - tera-4p - tera-2p - tera-1p - 110-punch - bnc - mrj21 - fc - lc - lc-apc - lsh - lsh-apc - mpo - mtrj - sc - sc-apc - st - cs - sn - urm-p2 - urm-p4 - urm-p8 - splice type: string type: object url: format: uri readOnly: true type: string required: - created - device_type - display - id - last_updated - name - type - url type: object Region: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: _depth: readOnly: true title: ' depth' type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/NestedRegion' nullable: true site_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - _depth - created - display - id - last_updated - name - notes_url - site_count - url type: object RegularExpressionValidationRule: description: Serializer for `RegularExpressionValidationRule` objects. properties: content_type: type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string regular_expression: type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - content_type - created - display - field - id - last_updated - name - regular_expression - slug - url type: object RegularExpressionValidationRuleRequest: description: Serializer for `RegularExpressionValidationRule` objects. properties: content_type: type: string enabled: type: boolean error_message: description: Optional error message to display when validation fails. maxLength: 255 nullable: true type: string field: maxLength: 50 minLength: 1 type: string name: maxLength: 100 minLength: 1 type: string regular_expression: minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_type - field - name - regular_expression - slug type: object Relationship: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: created: format: date nullable: true readOnly: true type: string description: maxLength: 200 type: string destination_filter: additionalProperties: {} description: Filterset filter matching the applicable destination objects of the selected type nullable: true type: object destination_hidden: description: Hide this relationship on the destination object. title: Hide for destination object type: boolean destination_label: description: Label for related source objects, as displayed on the destination object. maxLength: 50 type: string destination_type: type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the relationship as displayed to users maxLength: 100 type: string notes_url: format: uri readOnly: true type: string required_on: description: Objects on the specified side MUST implement this relationship. Not permitted for symmetric relationships. oneOf: - $ref: '#/components/schemas/RequiredOnEnum' - $ref: '#/components/schemas/BlankEnum' slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string source_filter: additionalProperties: {} description: Filterset filter matching the applicable source objects of the selected type nullable: true type: object source_hidden: description: Hide this relationship on the source object. title: Hide for source object type: boolean source_label: description: Label for related destination objects, as displayed on the source object. maxLength: 50 type: string source_type: type: string type: allOf: - $ref: '#/components/schemas/RelationshipTypeChoices' description: Cardinality of this relationship url: format: uri readOnly: true type: string required: - created - destination_type - display - id - last_updated - name - notes_url - source_type - url type: object RelationshipAssociation: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: destination_id: format: uuid type: string destination_type: type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string relationship: $ref: '#/components/schemas/NestedRelationship' source_id: format: uuid type: string source_type: type: string url: format: uri readOnly: true type: string required: - destination_id - destination_type - display - id - relationship - source_id - source_type - url type: object RelationshipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string destination_filter: additionalProperties: {} description: Filterset filter matching the applicable destination objects of the selected type nullable: true type: object destination_hidden: description: Hide this relationship on the destination object. title: Hide for destination object type: boolean destination_label: description: Label for related source objects, as displayed on the destination object. maxLength: 50 type: string destination_type: type: string name: description: Name of the relationship as displayed to users maxLength: 100 minLength: 1 type: string required_on: description: Objects on the specified side MUST implement this relationship. Not permitted for symmetric relationships. oneOf: - $ref: '#/components/schemas/RequiredOnEnum' - $ref: '#/components/schemas/BlankEnum' slug: description: Internal relationship name. Please use underscores rather than dashes in this slug. maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string source_filter: additionalProperties: {} description: Filterset filter matching the applicable source objects of the selected type nullable: true type: object source_hidden: description: Hide this relationship on the source object. title: Hide for source object type: boolean source_label: description: Label for related destination objects, as displayed on the source object. maxLength: 50 type: string source_type: type: string type: allOf: - $ref: '#/components/schemas/RelationshipTypeChoices' description: Cardinality of this relationship required: - destination_type - name - source_type type: object RelationshipTypeChoices: enum: - one-to-one - symmetric-one-to-one - one-to-many - many-to-many - symmetric-many-to-many type: string RequiredOnEnum: enum: - source - destination type: string Role: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string vlan_count: readOnly: true type: integer weight: maximum: 32767 minimum: 0 type: integer required: - created - display - id - last_updated - name - notes_url - prefix_count - url - vlan_count type: object RoleEnum: enum: - loopback - secondary - anycast - vip - vrrp - hsrp - glbp - carp type: string RoleRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string weight: maximum: 32767 minimum: 0 type: integer required: - name type: object RouteTarget: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 type: string notes_url: format: uri readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object ScheduledJob: description: 'This base serializer implements common fields and logic for all ModelSerializers. Namely, it: - defines the `display` field which exposes a human friendly value for the given object. - ensures that `id` field is always present on the serializer as well - ensures that `created` and `last_updated` fields are always present if applicable to this model and serializer.' properties: approval_required: type: boolean approved_at: description: Datetime that the schedule was approved format: date-time nullable: true readOnly: true title: Approval date/time type: string approved_by_user: allOf: - $ref: '#/components/schemas/NestedUser' readOnly: true crontab: description: Cronjob syntax string for custom scheduling maxLength: 255 title: Custom cronjob type: string date_changed: description: Datetime that this scheduled job was last modified format: date-time readOnly: true title: Last Modified type: string description: description: Detailed description about the details of this scheduled job type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string interval: $ref: '#/components/schemas/JobExecutionTypeIntervalChoices' job_class: description: Name of the fully qualified Nautobot Job class path maxLength: 255 type: string job_model: allOf: - $ref: '#/components/schemas/NestedJob' readOnly: true last_run_at: description: Datetime that the schedule last triggered the task to run. Reset to None if enabled is set to False. format: date-time nullable: true readOnly: true title: Most Recent Run type: string name: description: Short Description For This Task maxLength: 200 type: string queue: description: Queue defined in CELERY_TASK_QUEUES. Leave None for default queuing. maxLength: 200 nullable: true title: Queue Override type: string task: description: 'The name of the Celery task that should be run. (Example: "proj.tasks.import_contacts")' maxLength: 200 title: Task Name type: string total_run_count: description: Running count of how many times the schedule has triggered the task readOnly: true type: integer url: format: uri readOnly: true type: string user: allOf: - $ref: '#/components/schemas/NestedUser' readOnly: true required: - approved_at - approved_by_user - date_changed - display - id - interval - job_class - job_model - last_run_at - name - task - total_run_count - url - user type: object Secret: description: Serializer for `Secret` objects. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string parameters: additionalProperties: {} type: object provider: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - provider - url type: object SecretRequest: description: Serializer for `Secret` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string parameters: additionalProperties: {} type: object provider: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - provider type: object SecretTypeEnum: enum: - key - password - secret - token - username type: string SecretsGroup: description: Serializer for `SecretsGroup` objects. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string secrets: items: $ref: '#/components/schemas/NestedSecretsGroupAssociation' readOnly: true type: array slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - secrets - url type: object SecretsGroupAssociation: description: Serializer for `SecretsGroupAssociation` objects. properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' display: description: Human friendly display value readOnly: true type: string group: $ref: '#/components/schemas/NestedSecretsGroup' id: format: uuid readOnly: true type: string secret: $ref: '#/components/schemas/NestedSecret' secret_type: $ref: '#/components/schemas/SecretTypeEnum' url: format: uri readOnly: true type: string required: - access_type - display - group - id - secret - secret_type - url type: object SecretsGroupRequest: description: Serializer for `SecretsGroup` objects. properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object Service: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ipaddresses: items: properties: address: type: string display: description: Human friendly display value readOnly: true type: string family: readOnly: true type: integer id: format: uuid readOnly: true type: string url: format: uri readOnly: true type: string required: - address - display - family - id - url type: object type: array last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string ports: items: maximum: 65535 minimum: 1 type: integer type: array protocol: properties: label: enum: - TCP - UDP type: string value: enum: - tcp - udp type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string virtual_machine: allOf: - $ref: '#/components/schemas/NestedVirtualMachine' nullable: true required: - created - display - id - last_updated - name - notes_url - ports - url type: object ServiceObject: description: ServiceObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: allOf: - $ref: '#/components/schemas/IpProtocolEnum' description: IANA IP Protocol (e.g. TCP UDP ICMP) last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object ServiceObjectGroup: description: ServiceObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string service_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string ip_protocol: description: IANA IP Protocol (e.g. TCP UDP ICMP) enum: - ICMP - IGMP - GGP - TCP - CBT - EGP - IGP - BBN-RCC-MON - NVP-II - PUP - EMCON - XNET - CHAOS - UDP - MUX - DCN-MEAS - HMP - PRM - XNS-IDP - TRUNK-1 - TRUNK-2 - LEAF-1 - LEAF-2 - RDP - IRTP - ISO-TP4 - NETBLT - MFE-NSP - MERIT-INP - DCCP - 3PC - IDPR - XTP - DDP - IDPR-CMTP - TP++ - IL - SDRP - IDRP - RSVP - GRE - DSR - BNA - ESP - AH - I-NLSP - NARP - MOBILE - TLSP - SKIP - CFTP - SAT-EXPAK - KRYPTOLAN - RVD - IPPC - SAT-MON - VISA - IPCV - CPNX - CPHB - WSN - PVP - BR-SAT-MON - SUN-ND - WB-MON - WB-EXPAK - ISO-IP - VMTP - SECURE-VMTP - VINES - TTP - NSFNET-IGP - DGP - TCF - EIGRP - OSPFIGP - Sprite-RPC - LARP - MTP - AX.25 - IPIP - SCC-SP - ETHERIP - ENCAP - GMTP - IFMP - PNNI - PIM - ARIS - SCPS - QNX - A/N - IPComp - SNP - Compaq-Peer - IPX-in-IP - PGM - L2TP - DDX - IATP - STP - SRP - UTI - SMP - SM - PTP - FIRE - CRTP - CRUDP - SSCOPMCE - IPLT - SPS - PIPE - SCTP - FC - RSVP-E2E-IGNORE - UDPLite - manet - HIP - WESP - ROHC - Ethernet type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the service (e.g. HTTP) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - ip_protocol - last_updated - name - notes_url - url type: object type: array status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - notes_url - url type: object ServiceObjectRequest: description: ServiceObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string ip_protocol: allOf: - $ref: '#/components/schemas/IpProtocolEnum' description: IANA IP Protocol (e.g. TCP UDP ICMP) name: description: Name of the service (e.g. HTTP) maxLength: 100 minLength: 1 type: string port: description: The port or port range to tie to a service (e.g. HTTP would be port 80) maxLength: 20 nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - ip_protocol - name type: object SeverityEnum: enum: - Critical - High - Medium - Low - None type: string Site: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer circuit_count: readOnly: true type: integer comments: type: string contact_email: format: email maxLength: 254 title: Contact E-mail type: string contact_name: maxLength: 50 type: string contact_phone: maxLength: 20 type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string facility: description: Local facility ID or description maxLength: 50 type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string latitude: description: GPS coordinate (latitude) format: decimal nullable: true pattern: ^-?\d{0,2}(?:\.\d{0,6})?$ type: string longitude: description: GPS coordinate (longitude) format: decimal nullable: true pattern: ^-?\d{0,3}(?:\.\d{0,6})?$ type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string physical_address: maxLength: 200 type: string prefix_count: readOnly: true type: integer rack_count: readOnly: true type: integer region: allOf: - $ref: '#/components/schemas/NestedRegion' nullable: true shipping_address: maxLength: 200 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: properties: label: enum: - Active - Decommissioning - Planned - Retired - Staging type: string value: enum: - active - decommissioning - planned - retired - staging type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true time_zone: nullable: true type: string url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer vlan_count: readOnly: true type: integer required: - circuit_count - created - device_count - display - id - last_updated - name - notes_url - prefix_count - rack_count - status - url - virtualmachine_count - vlan_count type: object SoftwareImageLCM: description: REST API serializer for SoftwareImageLCM records. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object default_image: type: boolean device_types: items: format: uuid type: string type: array display: description: Human friendly display value readOnly: true type: string download_url: format: uri maxLength: 200 type: string id: format: uuid readOnly: true type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 type: string inventory_items: items: format: uuid type: string type: array last_updated: format: date-time nullable: true readOnly: true type: string object_tags: items: format: uuid type: string type: array software: $ref: '#/components/schemas/NestedSoftwareLCM' tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - image_file_name - last_updated - software - url type: object SoftwareLCM: description: REST API serializer for SoftwareLCM records. properties: alias: maxLength: 50 nullable: true type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_platform: $ref: '#/components/schemas/NestedPlatform' display: description: Human friendly display value readOnly: true type: string documentation_url: format: uri maxLength: 200 type: string end_of_support: format: date nullable: true title: End of Software Support type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string long_term_support: type: boolean pre_release: type: boolean release_date: format: date nullable: true type: string software_images: items: properties: default_image: type: boolean device_types: items: format: uuid type: string type: array display: description: Human friendly display value readOnly: true type: string download_url: format: uri maxLength: 200 type: string id: format: uuid readOnly: true type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array url: format: uri readOnly: true type: string required: - display - id - image_file_name - url type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string version: maxLength: 50 type: string required: - created - device_platform - display - id - last_updated - url - version type: object Status: description: Serializer for `Status` objects. properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 50 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string required: - content_types - created - display - id - last_updated - name - notes_url - url type: object Status2a0Enum: enum: - active - available - planned type: string Status4f5Enum: enum: [] type: string Status8f7Enum: enum: - active - decommissioned - staged type: string StatusD95Enum: enum: - TENTATIVE - CONFIRMED - CANCELLED - IN-PROCESS - COMPLETED - RE-SCHEDULED - UNKNOWN type: string StatusRequest: description: Serializer for `Status` objects. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object name: maxLength: 50 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 50 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - content_types - name type: object SubdeviceRoleEnum: enum: - parent - child type: string SupplyEnum: enum: - ac - dc type: string TagSerializerField: description: NestedSerializer field for `Tag` object fields. properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string slug: maxLength: 100 pattern: ^[-\w]+$ type: string url: format: uri readOnly: true type: string required: - created - display - id - last_updated - name - slug - url type: object TagSerializerFieldRequest: description: NestedSerializer field for `Tag` object fields. properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string name: maxLength: 100 minLength: 1 type: string slug: maxLength: 100 minLength: 1 pattern: ^[-\w]+$ type: string required: - id type: object TagSerializerVersion13: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string slug: maxLength: 100 pattern: ^[-\w]+$ type: string tagged_items: readOnly: true type: integer url: format: uri readOnly: true type: string required: - content_types - created - display - id - last_updated - name - notes_url - slug - tagged_items - url type: object TagSerializerVersion13Request: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 minLength: 1 pattern: ^[0-9a-f]{6}$ type: string content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 minLength: 1 pattern: ^[-\w]+$ type: string required: - content_types - name - slug type: object Tenant: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: circuit_count: readOnly: true type: integer cluster_count: readOnly: true type: integer comments: type: string created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_count: readOnly: true type: integer display: description: Human friendly display value readOnly: true type: string group: $ref: '#/components/schemas/NestedTenantGroup' id: format: uuid readOnly: true type: string ipaddress_count: readOnly: true type: integer last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix_count: readOnly: true type: integer rack_count: readOnly: true type: integer site_count: readOnly: true type: integer slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string virtualmachine_count: readOnly: true type: integer vlan_count: readOnly: true type: integer vrf_count: readOnly: true type: integer required: - circuit_count - cluster_count - created - device_count - display - id - ipaddress_count - last_updated - name - notes_url - prefix_count - rack_count - site_count - url - virtualmachine_count - vlan_count - vrf_count type: object TenantGroup: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: _depth: readOnly: true title: ' depth' type: integer created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string parent: allOf: - $ref: '#/components/schemas/NestedTenantGroup' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tenant_count: readOnly: true type: integer url: format: uri readOnly: true type: string required: - _depth - created - display - id - last_updated - name - notes_url - tenant_count - url type: object TermSideEnum: enum: - A - Z type: string Token: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: created: format: date-time readOnly: true type: string description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string expires: format: date-time nullable: true type: string id: format: uuid readOnly: true type: string key: maxLength: 40 minLength: 40 type: string url: format: uri readOnly: true type: string write_enabled: description: Permit create/update/delete operations using this key type: boolean required: - created - display - id - url type: object TokenRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: description: maxLength: 200 type: string expires: format: date-time nullable: true type: string key: maxLength: 40 minLength: 40 type: string write_enabled: description: Permit create/update/delete operations using this key type: boolean type: object User: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: date_joined: format: date-time type: string display: description: Human friendly display value readOnly: true type: string email: format: email maxLength: 254 title: Email address type: string first_name: maxLength: 150 type: string groups: items: properties: display: description: Human friendly display value readOnly: true type: string id: readOnly: true type: integer name: maxLength: 150 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object type: array id: format: uuid readOnly: true type: string is_active: description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. title: Active type: boolean is_staff: description: Designates whether the user can log into this admin site. title: Staff status type: boolean last_name: maxLength: 150 type: string url: format: uri readOnly: true type: string username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 pattern: ^[\w.@+-]+$ type: string required: - display - id - url - username type: object UserObject: description: UserObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 type: string required: - created - display - id - last_updated - notes_url - url - username type: object UserObjectGroup: description: UserObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string user_objects: items: properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 type: string required: - created - display - id - last_updated - notes_url - url - username type: object type: array required: - created - display - id - last_updated - name - notes_url - url type: object UserObjectRequest: description: UserObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object name: description: Signifies the name of the user, commonly first & last name (e.g. John Smith) maxLength: 100 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array username: description: Signifies the username in identify provider (e.g. john.smith) maxLength: 100 minLength: 1 type: string required: - username type: object VLAN: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string group: allOf: - $ref: '#/components/schemas/NestedVLANGroup' nullable: true id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string prefix_count: readOnly: true type: integer role: allOf: - $ref: '#/components/schemas/NestedRole' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSite' nullable: true status: properties: label: enum: - Active - Deprecated - Reserved type: string value: enum: - active - deprecated - reserved type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - created - display - id - last_updated - name - notes_url - prefix_count - status - url - vid type: object VLANGroup: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string site: allOf: - $ref: '#/components/schemas/NestedSite' nullable: true slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string url: format: uri readOnly: true type: string vlan_count: readOnly: true type: integer required: - created - display - id - last_updated - name - notes_url - url - vlan_count type: object VLANStatusChoices: enum: - active - deprecated - reserved type: string VMInterfaceSerializerVersion12: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: allOf: - $ref: '#/components/schemas/NestedVMInterface' nullable: true custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string enabled: type: boolean id: format: uuid readOnly: true type: string mac_address: maxLength: 18 nullable: true type: string mode: properties: label: enum: - Access - Tagged - Tagged (All) type: string value: enum: - access - tagged - tagged-all type: string type: object mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string parent_interface: allOf: - $ref: '#/components/schemas/NestedVMInterface' nullable: true tagged_vlans: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: maxLength: 64 type: string url: format: uri readOnly: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - display - id - name - url - vid type: object type: array tags: items: $ref: '#/components/schemas/TagSerializerField' type: array untagged_vlan: allOf: - $ref: '#/components/schemas/NestedVLAN' nullable: true url: format: uri readOnly: true type: string virtual_machine: $ref: '#/components/schemas/NestedVirtualMachine' required: - display - id - name - notes_url - url - virtual_machine type: object VRF: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string enforce_unique: description: Prevent duplicate prefixes/IP addresses within this VRF title: Enforce unique space type: boolean export_targets: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object type: array id: format: uuid readOnly: true type: string import_targets: items: properties: display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 type: string url: format: uri readOnly: true type: string required: - display - id - name - url type: object type: array ipaddress_count: readOnly: true type: integer last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 100 type: string notes_url: format: uri readOnly: true type: string prefix_count: readOnly: true type: integer rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string required: - created - display - id - ipaddress_count - last_updated - name - notes_url - prefix_count - url type: object ValidatedSoftwareLCM: description: REST API serializer for ValidatedSoftwareLCM records. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object device_roles: items: format: uuid type: string type: array device_types: items: format: uuid type: string type: array devices: items: format: uuid type: string type: array display: description: Human friendly display value readOnly: true type: string end: format: date nullable: true title: Valid Until type: string id: format: uuid readOnly: true type: string inventory_items: items: format: uuid type: string type: array last_updated: format: date-time nullable: true readOnly: true type: string object_tags: items: format: uuid type: string type: array preferred: title: Preferred Version type: boolean software: $ref: '#/components/schemas/NestedSoftwareLCM' start: format: date title: Valid Since type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string valid: readOnly: true type: string required: - created - display - id - last_updated - software - start - url - valid type: object VirtualChassis: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object display: description: Human friendly display value readOnly: true type: string domain: maxLength: 30 type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string master: allOf: - $ref: '#/components/schemas/NestedDevice' nullable: true member_count: readOnly: true type: integer name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - display - id - last_updated - member_count - name - notes_url - url type: object VirtualMachineStatusChoices: enum: - active - decommissioning - failed - offline - planned - staged type: string VirtualMachineWithConfigContext: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster: $ref: '#/components/schemas/NestedCluster' comments: type: string config_context: additionalProperties: {} readOnly: true type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object disk: maximum: 2147483647 minimum: 0 nullable: true title: Disk (GB) type: integer display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: allOf: - $ref: '#/components/schemas/NestedConfigContextSchema' nullable: true location: allOf: - $ref: '#/components/schemas/NestedLocation' nullable: true readOnly: true memory: maximum: 2147483647 minimum: 0 nullable: true title: Memory (MB) type: integer name: maxLength: 64 type: string notes_url: format: uri readOnly: true type: string platform: allOf: - $ref: '#/components/schemas/NestedPlatform' nullable: true primary_ip: allOf: - $ref: '#/components/schemas/NestedIPAddress' readOnly: true primary_ip4: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true primary_ip6: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true role: allOf: - $ref: '#/components/schemas/NestedDeviceRole' nullable: true site: allOf: - $ref: '#/components/schemas/NestedSite' readOnly: true status: properties: label: enum: - Active - Decommissioning - Failed - Offline - Planned - Staged type: string value: enum: - active - decommissioning - failed - offline - planned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array tenant: allOf: - $ref: '#/components/schemas/NestedTenant' nullable: true url: format: uri readOnly: true type: string vcpus: maximum: 32767 minimum: 0 nullable: true type: integer required: - cluster - config_context - created - display - id - last_updated - location - name - notes_url - primary_ip - site - status - url type: object VulnerabilityLCM: description: REST API serializer for VulnerabilityLCM records. properties: created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object cve: allOf: - $ref: '#/components/schemas/NestedCVELCM' readOnly: true device: allOf: - $ref: '#/components/schemas/NestedDevice' readOnly: true display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string inventory_item: allOf: - $ref: '#/components/schemas/NestedInventoryItem' readOnly: true last_updated: format: date-time nullable: true readOnly: true type: string software: allOf: - $ref: '#/components/schemas/NestedSoftwareLCM' readOnly: true status: properties: label: enum: [] type: string value: enum: [] type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string required: - created - cve - device - display - id - inventory_item - last_updated - software - status - url type: object VulnerabilityLCMRequest: description: REST API serializer for VulnerabilityLCM records. properties: custom_fields: additionalProperties: {} type: object relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - status type: object Webhook: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: additional_headers: description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is support with the same context as the request body (below).' type: string body_template: description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.' type: string ca_file_path: description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. maxLength: 4096 nullable: true type: string content_types: items: type: string type: array created: format: date nullable: true readOnly: true type: string display: description: Human friendly display value readOnly: true type: string http_content_type: description: The complete list of official content types is available here. maxLength: 100 type: string http_method: $ref: '#/components/schemas/HttpMethodEnum' id: format: uuid readOnly: true type: string last_updated: format: date-time nullable: true readOnly: true type: string name: maxLength: 150 type: string notes_url: format: uri readOnly: true type: string payload_url: description: A POST will be sent to this URL when the webhook is called. maxLength: 500 title: URL type: string secret: description: When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. maxLength: 255 type: string ssl_verification: description: Enable SSL certificate verification. Disable with caution! type: boolean type_create: description: Call this webhook when a matching object is created. type: boolean type_delete: description: Call this webhook when a matching object is deleted. type: boolean type_update: description: Call this webhook when a matching object is updated. type: boolean url: format: uri readOnly: true type: string required: - content_types - created - display - id - last_updated - name - notes_url - payload_url - url type: object WebhookRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: additional_headers: description: 'User-supplied HTTP headers to be sent with the request in addition to the HTTP content type. Headers should be defined in the format Name: Value. Jinja2 template processing is support with the same context as the request body (below).' type: string body_template: description: 'Jinja2 template for a custom request body. If blank, a JSON object representing the change will be included. Available context data includes: event, model, timestamp, username, request_id, and data.' type: string ca_file_path: description: The specific CA certificate file to use for SSL verification. Leave blank to use the system defaults. maxLength: 4096 nullable: true type: string content_types: items: type: string type: array http_content_type: description: The complete list of official content types is available here. maxLength: 100 minLength: 1 type: string http_method: $ref: '#/components/schemas/HttpMethodEnum' name: maxLength: 150 minLength: 1 type: string payload_url: description: A POST will be sent to this URL when the webhook is called. maxLength: 500 minLength: 1 title: URL type: string secret: description: When provided, the request will include a 'X-Hook-Signature' header containing a HMAC hex digest of the payload body using the secret as the key. The secret is not transmitted in the request. maxLength: 255 type: string ssl_verification: description: Enable SSL certificate verification. Disable with caution! type: boolean type_create: description: Call this webhook when a matching object is created. type: boolean type_delete: description: Call this webhook when a matching object is deleted. type: boolean type_update: description: Call this webhook when a matching object is updated. type: boolean required: - content_types - name - payload_url type: object WidthEnum: enum: - 10 - 19 - 21 - 23 type: integer WritableAddressFamilyRequest: description: REST API serializer for AddressFamily records. properties: afi_safi: $ref: '#/components/schemas/AfiSafiEnum' custom_fields: additionalProperties: {} type: object export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string routing_instance: format: uuid title: BGP Routing Instance type: string vrf: format: uuid nullable: true type: string required: - afi_safi - routing_instance type: object WritableAddressObjectGroupRequest: description: AddressObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Name descriptor for a group address objects. maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableAddressObjectRequest: description: AddressObject Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string fqdn: format: uuid nullable: true type: string ip_address: format: uuid nullable: true type: string ip_range: format: uuid nullable: true type: string name: description: Name descriptor for an address object type. maxLength: 100 minLength: 1 type: string prefix: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableAggregateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object date_added: format: date nullable: true type: string description: maxLength: 200 type: string prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object rir: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - prefix - rir type: object WritableAutonomousSystemRequest: description: REST API serializer for AutonomousSystem records. properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string provider: format: uuid nullable: true type: string status: $ref: '#/components/schemas/Status2a0Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - asn - status type: object WritableBGPRoutingInstanceRequest: description: REST API serializer for Peering records. properties: autonomous_system: format: uuid type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string router_id: format: uuid nullable: true type: string required: - autonomous_system - device type: object WritableCVELCMRequest: description: REST API serializer for CVELCM records. properties: comments: type: string custom_fields: additionalProperties: {} type: object cvss: format: double nullable: true title: CVSS Base Score type: number cvss_v2: format: double nullable: true title: CVSSv2 Score type: number cvss_v3: format: double nullable: true title: CVSSv3 Score type: number description: maxLength: 255 nullable: true type: string fix: maxLength: 255 nullable: true type: string link: format: uri maxLength: 200 minLength: 1 type: string name: maxLength: 16 minLength: 1 type: string published_date: format: date type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object severity: $ref: '#/components/schemas/SeverityEnum' status: $ref: '#/components/schemas/Status4f5Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - link - name - published_date type: object WritableCableRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: color: maxLength: 6 pattern: ^[0-9a-f]{6}$ type: string custom_fields: additionalProperties: {} type: object label: maxLength: 100 type: string length: maximum: 32767 minimum: 0 nullable: true type: integer length_unit: oneOf: - $ref: '#/components/schemas/LengthUnitEnum' - $ref: '#/components/schemas/BlankEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CableStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array termination_a_id: format: uuid type: string termination_a_type: type: string termination_b_id: format: uuid type: string termination_b_type: type: string type: oneOf: - $ref: '#/components/schemas/CableTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - status - termination_a_id - termination_a_type - termination_b_id - termination_b_type type: object WritableCircuitRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cid: maxLength: 100 minLength: 1 title: Circuit ID type: string comments: type: string commit_rate: maximum: 2147483647 minimum: 0 nullable: true title: Commit rate (Kbps) type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string install_date: format: date nullable: true title: Date installed type: string provider: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/CircuitStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: format: uuid type: string required: - cid - provider - status - type type: object WritableCircuitTerminationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: circuit: format: uuid type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location: format: uuid nullable: true type: string port_speed: maximum: 2147483647 minimum: 0 nullable: true title: Port speed (Kbps) type: integer pp_info: maxLength: 100 title: Patch panel/port(s) type: string provider_network: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string term_side: allOf: - $ref: '#/components/schemas/TermSideEnum' title: Termination upstream_speed: description: Upstream speed, if different from port speed maximum: 2147483647 minimum: 0 nullable: true title: Upstream speed (Kbps) type: integer xconnect_id: maxLength: 50 title: Cross-connect ID type: string required: - circuit - term_side type: object WritableClusterRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object group: format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: format: uuid type: string required: - name - type type: object WritableConfigContextRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: cluster_groups: items: format: uuid type: string type: array clusters: items: format: uuid type: string type: array data: additionalProperties: {} type: object description: maxLength: 200 type: string device_types: items: format: uuid type: string type: array is_active: type: boolean locations: items: format: uuid type: string type: array name: maxLength: 100 minLength: 1 type: string owner_content_type: nullable: true type: string owner_object_id: format: uuid nullable: true type: string platforms: items: format: uuid type: string type: array regions: items: format: uuid type: string type: array roles: items: format: uuid type: string type: array schema: description: Optional schema to validate the structure of the data format: uuid nullable: true type: string sites: items: format: uuid type: string type: array tags: items: type: string type: array tenant_groups: items: format: uuid type: string type: array tenants: items: format: uuid type: string type: array weight: maximum: 32767 minimum: 0 type: integer required: - data - name type: object WritableConsolePortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device - name type: object WritableConsolePortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device_type - name type: object WritableConsoleServerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device - name type: object WritableConsoleServerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/ConsolePortTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device_type - name type: object WritableContactLCMRequest: description: API serializer. properties: address: maxLength: 200 type: string comments: type: string contract: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object email: format: email maxLength: 254 title: Contact E-mail type: string name: maxLength: 80 minLength: 1 nullable: true type: string phone: maxLength: 20 type: string priority: maximum: 2147483647 minimum: 0 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - contract - name type: object WritableContractLCMRequest: description: API serializer. properties: contract_type: maxLength: 32 nullable: true type: string cost: format: decimal nullable: true pattern: ^-?\d{0,13}(?:\.\d{0,2})?$ title: Contract Cost type: string custom_fields: additionalProperties: {} type: object end: format: date nullable: true title: Contract End Date type: string name: maxLength: 100 minLength: 1 type: string provider: format: uuid nullable: true title: Vendor type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object start: format: date nullable: true title: Contract Start Date type: string support_level: maxLength: 64 nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableCustomFieldChoiceRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: field: format: uuid type: string value: maxLength: 100 minLength: 1 type: string weight: description: Higher weights appear later in the list maximum: 32767 minimum: 0 type: integer required: - field - value type: object WritableDeviceBayRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string installed_device: format: uuid nullable: true type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - name type: object WritableDeviceBayTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object required: - device_type - name type: object WritableDeviceRedundancyGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string failover_strategy: oneOf: - $ref: '#/components/schemas/FailoverStrategyEnum' - $ref: '#/components/schemas/BlankEnum' name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - status type: object WritableDeviceTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object front_image: format: binary type: string is_full_depth: description: Device consumes both front and rear rack faces type: boolean manufacturer: format: uuid type: string model: maxLength: 100 minLength: 1 type: string part_number: description: Discrete part number (optional) maxLength: 50 type: string rear_image: format: binary type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string subdevice_role: description: Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. oneOf: - $ref: '#/components/schemas/SubdeviceRoleEnum' - $ref: '#/components/schemas/BlankEnum' title: Parent/child status tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array u_height: maximum: 32767 minimum: 0 title: Height (U) type: integer required: - manufacturer - model type: object WritableDeviceWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this device maxLength: 50 nullable: true type: string cluster: format: uuid nullable: true type: string comments: type: string custom_fields: additionalProperties: {} type: object device_redundancy_group: format: uuid nullable: true type: string device_redundancy_group_priority: description: The priority the device has in the device redundancy group. maximum: 32767 minimum: 1 nullable: true type: integer device_role: format: uuid type: string device_type: format: uuid type: string face: oneOf: - $ref: '#/components/schemas/FaceEnum' - $ref: '#/components/schemas/BlankEnum' title: Rack face local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: description: Optional schema to validate the structure of the data format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 64 nullable: true type: string platform: format: uuid nullable: true type: string position: description: The lowest-numbered unit occupied by the device maximum: 32767 minimum: 1 nullable: true title: Position (U) type: integer primary_ip4: format: uuid nullable: true title: Primary IPv4 type: string primary_ip6: format: uuid nullable: true title: Primary IPv6 type: string rack: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object secrets_group: format: uuid nullable: true type: string serial: maxLength: 255 title: Serial number type: string site: format: uuid type: string status: $ref: '#/components/schemas/DeviceStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vc_position: maximum: 255 minimum: 0 nullable: true type: integer vc_priority: maximum: 255 minimum: 0 nullable: true type: integer virtual_chassis: format: uuid nullable: true type: string required: - device_role - device_type - site - status type: object WritableDynamicGroupMembershipRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: group: format: uuid type: string operator: $ref: '#/components/schemas/OperatorEnum' parent_group: format: uuid type: string weight: maximum: 32767 minimum: 0 type: integer required: - group - operator - parent_group - weight type: object WritableFQDNRequest: description: FQDN Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Resolvable fully qualified domain name (e.g. networktocode.com) maxLength: 254 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableFrontPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: format: uuid type: string rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' required: - device - name - rear_port - type type: object WritableFrontPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string rear_port: format: uuid type: string rear_port_position: default: 1 maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' required: - device_type - name - rear_port - type type: object WritableGitRepositoryRequest: description: Git repositories defined as a data source. properties: branch: maxLength: 64 minLength: 1 type: string current_head: description: Commit hash of the most recent fetch from the selected branch. Used for syncing between workers. maxLength: 48 type: string custom_fields: additionalProperties: {} type: object name: maxLength: 100 minLength: 1 type: string provided_contents: items: oneOf: - $ref: '#/components/schemas/ProvidedContentsEnum' - $ref: '#/components/schemas/BlankEnum' type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remote_url: description: Only HTTP and HTTPS URLs are presently supported format: uri maxLength: 255 minLength: 1 type: string secrets_group: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string token: minLength: 1 type: string writeOnly: true username: maxLength: 64 type: string required: - name - remote_url type: object WritableGoldenConfigSettingRequest: description: Serializer for GoldenConfigSetting object. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object backup_path_template: description: The Jinja path representation of where the backup file will be found. The variable `obj` is available as the device instance object of a given device, as is the case for all Jinja templates. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Backup Path in Jinja Template Form type: string backup_repository: format: uuid nullable: true type: string backup_test_connectivity: description: Whether or not to pretest the connectivity of the device by verifying there is a resolvable IP that can connect to port 22. title: Backup Test type: boolean custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dynamic_group: format: uuid type: string intended_path_template: description: The Jinja path representation of where the generated file will be places. e.g. `{{obj.site.slug}}/{{obj.name}}.cfg` maxLength: 255 title: Intended Path in Jinja Template Form type: string intended_repository: format: uuid nullable: true type: string jinja_path_template: description: The Jinja path representation of where the Jinja template can be found. e.g. `{{obj.platform.slug}}.j2` maxLength: 255 title: Template Path in Jinja Template Form type: string jinja_repository: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string scope: additionalProperties: {} type: object slug: maxLength: 100 minLength: 1 pattern: ^[-a-zA-Z0-9_]+$ type: string sot_agg_query: format: uuid nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array weight: maximum: 32767 minimum: 0 type: integer required: - dynamic_group - name - slug type: object WritableHardwareLCMRequest: description: API serializer. properties: custom_fields: additionalProperties: {} type: object device_type: format: uuid nullable: true type: string documentation_url: format: uri maxLength: 200 type: string end_of_sale: format: date nullable: true type: string end_of_security_patches: format: date nullable: true type: string end_of_support: format: date nullable: true type: string end_of_sw_releases: format: date nullable: true title: End of Software Releases type: string inventory_item: maxLength: 255 nullable: true title: Inventory Item Part type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: object WritableIPAddressRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: address: minLength: 1 type: string assigned_object_id: format: uuid nullable: true type: string assigned_object_type: nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string dns_name: description: Hostname or FQDN (not case-sensitive) maxLength: 255 pattern: ^[0-9A-Za-z._-]+$ type: string nat_inside: description: The IP Addresses for which this address is the "outside" IP format: uuid nullable: true title: NAT (Inside) type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: description: The functional role of this IP oneOf: - $ref: '#/components/schemas/RoleEnum' - $ref: '#/components/schemas/BlankEnum' status: $ref: '#/components/schemas/IPAddressStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vrf: format: uuid nullable: true type: string required: - address - status type: object WritableInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: description: Assigned bridge interface format: uuid nullable: true title: Bridge interface type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string enabled: type: boolean label: description: Physical label maxLength: 64 type: string lag: description: Assigned LAG interface format: uuid nullable: true title: Parent LAG type: string mac_address: maxLength: 18 nullable: true type: string mgmt_only: description: This interface is used only for out-of-band management title: Management only type: boolean mode: oneOf: - $ref: '#/components/schemas/ModeEnum' - $ref: '#/components/schemas/BlankEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: description: Assigned parent interface format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: format: uuid title: Tagged VLANs type: string type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/InterfaceTypeChoices' untagged_vlan: format: uuid nullable: true type: string required: - device - name - status - type type: object WritableInterfaceTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string mgmt_only: title: Management only type: boolean name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/InterfaceTypeChoices' required: - device_type - name - type type: object WritableInventoryItemRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this item maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string discovered: description: This item was automatically discovered type: boolean label: description: Physical label maxLength: 64 type: string manufacturer: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string parent: format: uuid nullable: true type: string part_id: description: Manufacturer-assigned part identifier maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object serial: maxLength: 255 title: Serial number type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - device - name type: object WritableLocationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location_type: format: uuid type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - location_type - name - status type: object WritableLocationTypeRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: content_types: items: type: string type: array custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string nestable: description: Allow Locations of this type to be parents/children of other Locations of this same type type: boolean parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object WritableNATPolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/ZoneRequest' index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object remark: type: boolean request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableObjectPermissionRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: actions: additionalProperties: {} description: The list of actions granted by this permission type: object constraints: additionalProperties: {} description: Queryset filter matching the applicable objects of the selected type(s) nullable: true type: object description: maxLength: 200 type: string enabled: type: boolean groups: items: type: integer type: array name: maxLength: 100 minLength: 1 type: string object_types: items: type: string type: array users: items: format: uuid type: string type: array required: - actions - name - object_types type: object WritablePeerEndpointRequest: description: REST API serializer for PeerEndpoint records. properties: autonomous_system: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object enabled: type: boolean export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string peer: format: uuid nullable: true type: string peer_group: format: uuid nullable: true type: string peering: format: uuid type: string routing_instance: format: uuid nullable: true title: BGP Routing Instance type: string secret: format: uuid nullable: true type: string source_interface: format: uuid nullable: true type: string source_ip: format: uuid nullable: true title: BGP Peer IP type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - peering type: object WritablePeerGroupRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string routing_instance: format: uuid type: string secret: format: uuid nullable: true type: string source_interface: format: uuid nullable: true type: string source_ip: format: uuid nullable: true title: Source IP Address type: string template: format: uuid nullable: true type: string required: - name - routing_instance type: object WritablePeerGroupTemplateRequest: description: REST API serializer for PeerGroup records. properties: autonomous_system: format: uuid nullable: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean export_policy: maxLength: 100 type: string import_policy: maxLength: 100 type: string name: maxLength: 100 minLength: 1 type: string role: format: uuid nullable: true type: string secret: format: uuid nullable: true type: string required: - name type: object WritablePlatformRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string manufacturer: description: Optionally limit this platform to devices of a certain manufacturer format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string napalm_args: additionalProperties: {} description: Additional arguments to pass when initiating the NAPALM driver (JSON format) nullable: true title: NAPALM arguments type: object napalm_driver: description: The name of the NAPALM driver to use when interacting with devices maxLength: 50 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object WritablePolicyRuleRequest: description: PolicyRule Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object action: $ref: '#/components/schemas/ActionEnum' custom_fields: additionalProperties: {} type: object description: maxLength: 200 nullable: true type: string destination_zone: $ref: '#/components/schemas/ZoneRequest' index: maximum: 32767 minimum: 0 nullable: true type: integer log: type: boolean name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object request_id: maxLength: 100 nullable: true type: string source_zone: $ref: '#/components/schemas/ZoneRequest' status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - action - name type: object WritablePowerFeedRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: amperage: maximum: 32767 minimum: 1 type: integer comments: type: string custom_fields: additionalProperties: {} type: object max_utilization: description: Maximum permissible draw (percentage) maximum: 100 minimum: 1 type: integer name: maxLength: 100 minLength: 1 type: string phase: $ref: '#/components/schemas/PhaseEnum' power_panel: format: uuid type: string rack: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/PowerFeedStatusChoices' supply: $ref: '#/components/schemas/SupplyEnum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PowerFeedTypeChoices' voltage: maximum: 32767 minimum: -32768 type: integer required: - name - power_panel - status type: object WritablePowerOutletRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string feed_leg: description: Phase (for three-phase feeds) oneOf: - $ref: '#/components/schemas/FeedLegEnum' - $ref: '#/components/schemas/BlankEnum' label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/PowerOutletTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device - name type: object WritablePowerOutletTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string feed_leg: description: Phase (for three-phase feeds) oneOf: - $ref: '#/components/schemas/FeedLegEnum' - $ref: '#/components/schemas/BlankEnum' label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string power_port: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/PowerOutletTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device_type - name type: object WritablePowerPanelRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string rack_group: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - site type: object WritablePowerPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: description: Physical port type oneOf: - $ref: '#/components/schemas/PowerPortTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device - name type: object WritablePowerPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: allocated_draw: description: Allocated power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string maximum_draw: description: Maximum power draw (watts) maximum: 32767 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: oneOf: - $ref: '#/components/schemas/PowerPortTypeChoices' - $ref: '#/components/schemas/BlankEnum' required: - device_type - name type: object WritablePrefixRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string is_pool: description: All IP addresses within this prefix are considered usable title: Is a pool type: boolean location: format: uuid nullable: true type: string prefix: minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: description: The primary function of this prefix format: uuid nullable: true type: string site: format: uuid nullable: true type: string status: $ref: '#/components/schemas/PrefixStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vlan: format: uuid nullable: true type: string vrf: format: uuid nullable: true type: string required: - prefix - status type: object WritableProviderNetworkRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string provider: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name - provider type: object WritableRackGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name - site type: object WritableRackRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asset_tag: description: A unique tag used to identify this rack maxLength: 50 nullable: true type: string comments: type: string custom_fields: additionalProperties: {} type: object desc_units: description: Units are numbered top-to-bottom title: Descending units type: boolean facility_id: description: Locally-assigned identifier maxLength: 50 nullable: true type: string group: description: Assigned group format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string outer_depth: description: Outer dimension of rack (depth) maximum: 32767 minimum: 0 nullable: true type: integer outer_unit: oneOf: - $ref: '#/components/schemas/OuterUnitEnum' - $ref: '#/components/schemas/BlankEnum' outer_width: description: Outer dimension of rack (width) maximum: 32767 minimum: 0 nullable: true type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: description: Functional role format: uuid nullable: true type: string serial: maxLength: 255 title: Serial number type: string site: format: uuid type: string status: $ref: '#/components/schemas/RackStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string type: oneOf: - $ref: '#/components/schemas/RackTypeChoices' - $ref: '#/components/schemas/BlankEnum' u_height: description: Height in rack units maximum: 100 minimum: 1 title: Height (U) type: integer width: allOf: - $ref: '#/components/schemas/WidthEnum' description: Rail-to-rail width maximum: 32767 minimum: 0 required: - name - site - status type: object WritableRackReservationRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 minLength: 1 type: string rack: format: uuid type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string units: additionalProperties: {} type: object user: format: uuid type: string required: - description - rack - units - user type: object WritableRearPortRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array type: $ref: '#/components/schemas/PortTypeChoices' required: - device - name - type type: object WritableRearPortTemplateRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device_type: format: uuid type: string label: description: Physical label maxLength: 64 type: string name: maxLength: 64 minLength: 1 type: string positions: maximum: 1024 minimum: 1 type: integer relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object type: $ref: '#/components/schemas/PortTypeChoices' required: - device_type - name - type type: object WritableRegionRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object WritableRelationshipAssociationRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: destination_id: format: uuid type: string destination_type: type: string relationship: format: uuid type: string source_id: format: uuid type: string source_type: type: string required: - destination_id - destination_type - relationship - source_id - source_type type: object WritableRouteTargetRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - name type: object WritableSecretsGroupAssociationRequest: description: Serializer for `SecretsGroupAssociation` objects. properties: access_type: $ref: '#/components/schemas/AccessTypeEnum' group: format: uuid type: string secret: format: uuid type: string secret_type: $ref: '#/components/schemas/SecretTypeEnum' required: - access_type - group - secret - secret_type type: object WritableServiceObjectGroupRequest: description: ServiceObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableServiceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string device: format: uuid nullable: true type: string ipaddresses: items: format: uuid title: IP addresses type: string title: IP addresses type: array name: maxLength: 100 minLength: 1 type: string ports: items: maximum: 65535 minimum: 1 type: integer type: array protocol: $ref: '#/components/schemas/ProtocolEnum' relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array virtual_machine: format: uuid nullable: true type: string required: - name - ports - protocol type: object WritableSiteRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: asn: description: 32-bit autonomous system number format: int64 maximum: 4294967295 minimum: 1 nullable: true type: integer comments: type: string contact_email: format: email maxLength: 254 title: Contact E-mail type: string contact_name: maxLength: 50 type: string contact_phone: maxLength: 20 type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string facility: description: Local facility ID or description maxLength: 50 type: string latitude: description: GPS coordinate (latitude) format: decimal nullable: true pattern: ^-?\d{0,2}(?:\.\d{0,6})?$ type: string longitude: description: GPS coordinate (longitude) format: decimal nullable: true pattern: ^-?\d{0,3}(?:\.\d{0,6})?$ type: string name: maxLength: 100 minLength: 1 type: string physical_address: maxLength: 200 type: string region: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object shipping_address: maxLength: 200 type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string status: $ref: '#/components/schemas/LocationStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string time_zone: nullable: true type: string required: - name - status type: object WritableSoftwareImageLCMRequest: description: REST API serializer for SoftwareImageLCM records. properties: custom_fields: additionalProperties: {} type: object default_image: type: boolean device_types: items: format: uuid type: string type: array download_url: format: uri maxLength: 200 type: string image_file_checksum: maxLength: 256 type: string image_file_name: maxLength: 100 minLength: 1 type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: format: uuid title: Software Version type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - image_file_name - software type: object WritableSoftwareLCMRequest: description: REST API serializer for SoftwareLCM records. properties: alias: maxLength: 50 nullable: true type: string custom_fields: additionalProperties: {} type: object device_platform: format: uuid type: string documentation_url: format: uri maxLength: 200 type: string end_of_support: format: date nullable: true title: End of Software Support type: string long_term_support: type: boolean pre_release: type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object release_date: format: date nullable: true type: string software_images: items: format: uuid type: string type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array version: maxLength: 50 minLength: 1 type: string required: - device_platform - software_images - version type: object WritableTenantGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string parent: format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object WritableTenantRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: comments: type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableUserObjectGroupRequest: description: UserObjectGroup Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableUserRequest: description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: date_joined: format: date-time type: string email: format: email maxLength: 254 title: Email address type: string first_name: maxLength: 150 type: string groups: description: The groups this user belongs to. A user will get all permissions granted to each of their groups. items: type: integer type: array is_active: description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. title: Active type: boolean is_staff: description: Designates whether the user can log into this admin site. title: Staff status type: boolean last_name: maxLength: 150 type: string password: maxLength: 128 minLength: 1 type: string writeOnly: true username: description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. maxLength: 150 minLength: 1 pattern: ^[\w.@+-]+$ type: string required: - password - username type: object WritableVLANGroupRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string location: format: uuid nullable: true type: string name: maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object site: format: uuid nullable: true type: string slug: maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: string required: - name type: object WritableVLANRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string group: format: uuid nullable: true type: string location: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: format: uuid nullable: true type: string site: format: uuid nullable: true type: string status: $ref: '#/components/schemas/VLANStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vid: maximum: 4094 minimum: 1 title: ID type: integer required: - name - status - vid type: object WritableVMInterfaceRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: bridge: description: Assigned bridge interface format: uuid nullable: true title: Bridge interface type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enabled: type: boolean mac_address: maxLength: 18 nullable: true type: string mode: oneOf: - $ref: '#/components/schemas/ModeEnum' - $ref: '#/components/schemas/BlankEnum' mtu: maximum: 65536 minimum: 1 nullable: true type: integer name: maxLength: 64 minLength: 1 type: string parent_interface: description: Assigned parent interface format: uuid nullable: true type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/InterfaceStatusChoices' tagged_vlans: items: format: uuid title: Tagged VLANs type: string type: array tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array untagged_vlan: format: uuid nullable: true type: string virtual_machine: format: uuid type: string required: - name - status - virtual_machine type: object WritableVRFRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string enforce_unique: description: Prevent duplicate prefixes/IP addresses within this VRF title: Enforce unique space type: boolean export_targets: items: format: uuid type: string type: array import_targets: items: format: uuid type: string type: array name: maxLength: 100 minLength: 1 type: string rd: description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 nullable: true title: Route distinguisher type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string required: - name type: object WritableValidatedSoftwareLCMRequest: description: REST API serializer for ValidatedSoftwareLCM records. properties: custom_fields: additionalProperties: {} type: object device_roles: items: format: uuid type: string type: array device_types: items: format: uuid type: string type: array devices: items: format: uuid type: string type: array end: format: date nullable: true title: Valid Until type: string inventory_items: items: format: uuid type: string type: array object_tags: items: format: uuid type: string type: array preferred: title: Preferred Version type: boolean relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object software: format: uuid title: Software Version type: string start: format: date title: Valid Since type: string tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - software - start type: object WritableVirtualChassisRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: custom_fields: additionalProperties: {} type: object domain: maxLength: 30 type: string master: format: uuid nullable: true type: string name: maxLength: 64 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - name type: object WritableVirtualMachineWithConfigContextRequest: description: 'Base class to use for serializers based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support custom fields and relationships.' properties: cluster: format: uuid type: string comments: type: string custom_fields: additionalProperties: {} type: object disk: maximum: 2147483647 minimum: 0 nullable: true title: Disk (GB) type: integer local_context_data: additionalProperties: {} nullable: true type: object local_context_schema: description: Optional schema to validate the structure of the data format: uuid nullable: true type: string memory: maximum: 2147483647 minimum: 0 nullable: true title: Memory (MB) type: integer name: maxLength: 64 minLength: 1 type: string platform: format: uuid nullable: true type: string primary_ip4: format: uuid nullable: true title: Primary IPv4 type: string primary_ip6: format: uuid nullable: true title: Primary IPv6 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object role: format: uuid nullable: true type: string status: $ref: '#/components/schemas/VirtualMachineStatusChoices' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array tenant: format: uuid nullable: true type: string vcpus: maximum: 32767 minimum: 0 nullable: true type: integer required: - cluster - name - status type: object Zone: description: Zone Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object created: format: date nullable: true readOnly: true type: string custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string display: description: Human friendly display value readOnly: true type: string id: format: uuid readOnly: true type: string interfaces: items: $ref: '#/components/schemas/NestedInterface' type: array last_updated: format: date-time nullable: true readOnly: true type: string name: description: Name of the zone (e.g. trust) maxLength: 100 type: string notes_url: format: uri readOnly: true type: string status: properties: label: enum: - Active - Decommissioned - Staged type: string value: enum: - active - decommissioned - staged type: string type: object tags: items: $ref: '#/components/schemas/TagSerializerField' type: array url: format: uri readOnly: true type: string vrfs: items: format: uuid type: string readOnly: true type: array required: - created - display - id - last_updated - name - notes_url - url - vrfs type: object ZoneRequest: description: Zone Serializer. properties: _custom_field_data: additionalProperties: {} title: ' custom field data' type: object custom_fields: additionalProperties: {} type: object description: maxLength: 200 type: string interfaces: items: $ref: '#/components/schemas/NestedInterfaceRequest' type: array name: description: Name of the zone (e.g. trust) maxLength: 100 minLength: 1 type: string relationships: properties: destination: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object id: format: uuid readOnly: true type: string name: readOnly: true type: string peer: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object source: properties: label: readOnly: true type: string object_type: example: dcim.site readOnly: true type: string objects: items: additionalProperties: true properties: display: readOnly: true type: string id: format: uuid type: string url: format: uri readOnly: true type: string type: object type: array type: object type: example: one-to-many readOnly: true type: string url: format: uri readOnly: true type: string required: - id - url - name - type type: object status: $ref: '#/components/schemas/Status8f7Enum' tags: items: $ref: '#/components/schemas/TagSerializerFieldRequest' type: array required: - id type: object securitySchemes: basicAuth: scheme: basic type: http cookieAuth: in: cookie name: sessionid type: apiKey tokenAuth: description: Token-based authentication with required prefix "Token" in: header name: Authorization type: apiKey info: description: Source of truth and network automation platform license: name: Apache v2 License title: API Documentation version: 1.5.7 (1.3) openapi: 3.0.3 paths: /circuits/circuit-terminations/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_list parameters: - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - description: Circuit explode: true in: query name: circuit_id schema: items: format: uuid type: string type: array style: form - description: Circuit explode: true in: query name: circuit_id__n schema: items: format: uuid type: string type: array style: form - description: Connected status (bool) in: query name: connected schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: port_speed schema: items: type: integer type: array style: form - explode: true in: query name: port_speed__gt schema: items: type: integer type: array style: form - explode: true in: query name: port_speed__gte schema: items: type: integer type: array style: form - explode: true in: query name: port_speed__lt schema: items: type: integer type: array style: form - explode: true in: query name: port_speed__lte schema: items: type: integer type: array style: form - explode: true in: query name: port_speed__n schema: items: type: integer type: array style: form - description: Provider Network (ID) explode: true in: query name: provider_network_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Provider Network (ID) explode: true in: query name: provider_network_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid nullable: true type: string type: array style: form - in: query name: term_side schema: title: Termination type: string - in: query name: term_side__n schema: title: Termination type: string - explode: true in: query name: upstream_speed schema: items: type: integer type: array style: form - explode: true in: query name: upstream_speed__gt schema: items: type: integer type: array style: form - explode: true in: query name: upstream_speed__gte schema: items: type: integer type: array style: form - explode: true in: query name: upstream_speed__lt schema: items: type: integer type: array style: form - explode: true in: query name: upstream_speed__lte schema: items: type: integer type: array style: form - explode: true in: query name: upstream_speed__n schema: items: type: integer type: array style: form - explode: true in: query name: xconnect_id schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__ic schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__ie schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__iew schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__ire schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__isw schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__n schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__nic schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__nie schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__niew schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__nire schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__nisw schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__nre schema: items: type: string type: array style: form - explode: true in: query name: xconnect_id__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCircuitTerminationList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCircuitTerminationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitTermination' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTerminationRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitTermination' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCircuitTerminationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitTermination' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuit-terminations/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_destroy parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_retrieve parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitTermination' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_partial_update parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCircuitTerminationRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitTermination' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_terminations_update parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCircuitTerminationRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitTermination' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuit-terminations/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: circuits_circuit_terminations_notes_list parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: API methods for returning or creating notes on an object. operationId: circuits_circuit_terminations_notes_create parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuit-terminations/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: circuits_circuit_terminations_trace_retrieve parameters: - description: A UUID string identifying this circuit termination. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitTermination' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuit-types/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCircuitTypeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCircuitTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitTypeRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCircuitTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuit-types/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_destroy parameters: - description: A UUID string identifying this circuit type. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_retrieve parameters: - description: A UUID string identifying this circuit type. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_partial_update parameters: - description: A UUID string identifying this circuit type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCircuitTypeRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_circuit_types_update parameters: - description: A UUID string identifying this circuit type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitTypeRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuit-types/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: circuits_circuit_types_notes_list parameters: - description: A UUID string identifying this circuit type. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: API methods for returning or creating notes on an object. operationId: circuits_circuit_types_notes_create parameters: - description: A UUID string identifying this circuit type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuits/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_list parameters: - explode: true in: query name: cid schema: items: type: string type: array style: form - explode: true in: query name: cid__ic schema: items: type: string type: array style: form - explode: true in: query name: cid__ie schema: items: type: string type: array style: form - explode: true in: query name: cid__iew schema: items: type: string type: array style: form - explode: true in: query name: cid__ire schema: items: type: string type: array style: form - explode: true in: query name: cid__isw schema: items: type: string type: array style: form - explode: true in: query name: cid__n schema: items: type: string type: array style: form - explode: true in: query name: cid__nic schema: items: type: string type: array style: form - explode: true in: query name: cid__nie schema: items: type: string type: array style: form - explode: true in: query name: cid__niew schema: items: type: string type: array style: form - explode: true in: query name: cid__nire schema: items: type: string type: array style: form - explode: true in: query name: cid__nisw schema: items: type: string type: array style: form - explode: true in: query name: cid__nre schema: items: type: string type: array style: form - explode: true in: query name: cid__re schema: items: type: string type: array style: form - explode: true in: query name: commit_rate schema: items: type: integer type: array style: form - explode: true in: query name: commit_rate__gt schema: items: type: integer type: array style: form - explode: true in: query name: commit_rate__gte schema: items: type: integer type: array style: form - explode: true in: query name: commit_rate__lt schema: items: type: integer type: array style: form - explode: true in: query name: commit_rate__lte schema: items: type: integer type: array style: form - explode: true in: query name: commit_rate__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: install_date schema: items: format: date type: string type: array style: form - explode: true in: query name: install_date__gt schema: items: format: date type: string type: array style: form - explode: true in: query name: install_date__gte schema: items: format: date type: string type: array style: form - explode: true in: query name: install_date__lt schema: items: format: date type: string type: array style: form - explode: true in: query name: install_date__lte schema: items: format: date type: string type: array style: form - explode: true in: query name: install_date__n schema: items: format: date type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Provider (slug) explode: true in: query name: provider schema: items: type: string type: array style: form - description: Provider (slug) explode: true in: query name: provider__n schema: items: type: string type: array style: form - description: Provider (ID) explode: true in: query name: provider_id schema: items: format: uuid type: string type: array style: form - description: Provider (ID) explode: true in: query name: provider_id__n schema: items: format: uuid type: string type: array style: form - description: Provider Network (ID) explode: true in: query name: provider_network_id schema: items: format: uuid type: string type: array style: form - description: Provider Network (ID) explode: true in: query name: provider_network_id__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Circuit type (slug) explode: true in: query name: type schema: items: type: string type: array style: form - description: Circuit type (slug) explode: true in: query name: type__n schema: items: type: string type: array style: form - description: Circuit type (ID) explode: true in: query name: type_id schema: items: format: uuid type: string type: array style: form - description: Circuit type (ID) explode: true in: query name: type_id__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCircuitList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCircuitRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Circuit' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCircuitRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Circuit' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCircuitRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Circuit' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuits/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_destroy parameters: - description: A UUID string identifying this circuit. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_retrieve parameters: - description: A UUID string identifying this circuit. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Circuit' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_partial_update parameters: - description: A UUID string identifying this circuit. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCircuitRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Circuit' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: circuits_circuits_update parameters: - description: A UUID string identifying this circuit. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCircuitRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Circuit' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/circuits/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: circuits_circuits_notes_list parameters: - description: A UUID string identifying this circuit. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: API methods for returning or creating notes on an object. operationId: circuits_circuits_notes_create parameters: - description: A UUID string identifying this circuit. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/provider-networks/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Provider (slug) explode: true in: query name: provider schema: items: type: string type: array style: form - description: Provider (slug) explode: true in: query name: provider__n schema: items: type: string type: array style: form - description: Provider (ID) explode: true in: query name: provider_id schema: items: format: uuid type: string type: array style: form - description: Provider (ID) explode: true in: query name: provider_id__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedProviderNetworkList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableProviderNetworkRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ProviderNetwork' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableProviderNetworkRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableProviderNetworkRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ProviderNetwork' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/provider-networks/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_destroy parameters: - description: A UUID string identifying this provider network. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_retrieve parameters: - description: A UUID string identifying this provider network. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_partial_update parameters: - description: A UUID string identifying this provider network. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableProviderNetworkRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_provider_networks_update parameters: - description: A UUID string identifying this provider network. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableProviderNetworkRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderNetwork' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/provider-networks/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: circuits_provider_networks_notes_list parameters: - description: A UUID string identifying this provider network. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: API methods for returning or creating notes on an object. operationId: circuits_provider_networks_notes_create parameters: - description: A UUID string identifying this provider network. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/providers/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_list parameters: - explode: true in: query name: account schema: items: type: string type: array style: form - explode: true in: query name: account__ic schema: items: type: string type: array style: form - explode: true in: query name: account__ie schema: items: type: string type: array style: form - explode: true in: query name: account__iew schema: items: type: string type: array style: form - explode: true in: query name: account__ire schema: items: type: string type: array style: form - explode: true in: query name: account__isw schema: items: type: string type: array style: form - explode: true in: query name: account__n schema: items: type: string type: array style: form - explode: true in: query name: account__nic schema: items: type: string type: array style: form - explode: true in: query name: account__nie schema: items: type: string type: array style: form - explode: true in: query name: account__niew schema: items: type: string type: array style: form - explode: true in: query name: account__nire schema: items: type: string type: array style: form - explode: true in: query name: account__nisw schema: items: type: string type: array style: form - explode: true in: query name: account__nre schema: items: type: string type: array style: form - explode: true in: query name: account__re schema: items: type: string type: array style: form - explode: true in: query name: asn schema: items: type: integer type: array style: form - explode: true in: query name: asn__gt schema: items: type: integer type: array style: form - explode: true in: query name: asn__gte schema: items: type: integer type: array style: form - explode: true in: query name: asn__lt schema: items: type: integer type: array style: form - explode: true in: query name: asn__lte schema: items: type: integer type: array style: form - explode: true in: query name: asn__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedProviderList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableProviderRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Provider' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Provider' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableProviderRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Provider' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/providers/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_destroy parameters: - description: A UUID string identifying this provider. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - circuits get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_retrieve parameters: - description: A UUID string identifying this provider. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Provider' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_partial_update parameters: - description: A UUID string identifying this provider. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProviderRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Provider' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: circuits_providers_update parameters: - description: A UUID string identifying this provider. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Provider' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /circuits/providers/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: circuits_providers_notes_list parameters: - description: A UUID string identifying this provider. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits post: description: API methods for returning or creating notes on an object. operationId: circuits_providers_notes_create parameters: - description: A UUID string identifying this provider. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - circuits /dcim/cables/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_list parameters: - explode: true in: query name: color schema: items: type: string type: array style: form - explode: true in: query name: color__ic schema: items: type: string type: array style: form - explode: true in: query name: color__ie schema: items: type: string type: array style: form - explode: true in: query name: color__iew schema: items: type: string type: array style: form - explode: true in: query name: color__ire schema: items: type: string type: array style: form - explode: true in: query name: color__isw schema: items: type: string type: array style: form - explode: true in: query name: color__n schema: items: type: string type: array style: form - explode: true in: query name: color__nic schema: items: type: string type: array style: form - explode: true in: query name: color__nie schema: items: type: string type: array style: form - explode: true in: query name: color__niew schema: items: type: string type: array style: form - explode: true in: query name: color__nire schema: items: type: string type: array style: form - explode: true in: query name: color__nisw schema: items: type: string type: array style: form - explode: true in: query name: color__nre schema: items: type: string type: array style: form - explode: true in: query name: color__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device (name) explode: true in: query name: device schema: items: type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - explode: true in: query name: length schema: items: type: integer type: array style: form - explode: true in: query name: length__gt schema: items: type: integer type: array style: form - explode: true in: query name: length__gte schema: items: type: integer type: array style: form - explode: true in: query name: length__lt schema: items: type: integer type: array style: form - explode: true in: query name: length__lte schema: items: type: integer type: array style: form - explode: true in: query name: length__n schema: items: type: integer type: array style: form - in: query name: length_unit schema: type: string - in: query name: length_unit__n schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Rack (name) explode: true in: query name: rack schema: items: type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id schema: items: format: uuid type: string type: array style: form - description: Region (name) explode: true in: query name: region schema: items: type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Site (name) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (name) explode: true in: query name: tenant schema: items: type: string type: array style: form - description: Tenant (ID) explode: true in: query name: tenant_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_a_type schema: items: type: integer type: array style: form - explode: true in: query name: termination_a_type__n schema: items: type: integer type: array style: form - explode: true in: query name: termination_b_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: termination_b_type schema: items: type: integer type: array style: form - explode: true in: query name: termination_b_type__n schema: items: type: integer type: array style: form - explode: true in: query name: type schema: items: type: string type: array style: form - explode: true in: query name: type__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCableList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCableRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Cable' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCableRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cable' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCableRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Cable' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/cables/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_destroy parameters: - description: A UUID string identifying this cable. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_retrieve parameters: - description: A UUID string identifying this cable. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cable' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_partial_update parameters: - description: A UUID string identifying this cable. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCableRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cable' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_cables_update parameters: - description: A UUID string identifying this cable. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCableRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cable' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/cables/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_cables_notes_list parameters: - description: A UUID string identifying this cable. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_cables_notes_create parameters: - description: A UUID string identifying this cable. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/connected-device/: get: description: 'This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors via a protocol such as LLDP. Two query parameters must be included in the request: * `peer_device`: The name of the peer device * `peer_interface`: The name of the peer interface' operationId: dcim_connected_device_list parameters: - description: The name of the peer device in: query name: peer_device required: true schema: type: string - description: The name of the peer interface in: query name: peer_interface required: true schema: type: string responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Device' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-connections/: get: operationId: dcim_console_connections_list parameters: - description: Device (name) explode: true in: query name: device schema: items: type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Site (slug) in: query name: site schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConsolePortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-port-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConsolePortTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConsolePortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsolePortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsolePortTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConsolePortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsolePortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-port-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_destroy parameters: - description: A UUID string identifying this console port template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_retrieve parameters: - description: A UUID string identifying this console port template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_partial_update parameters: - description: A UUID string identifying this console port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsolePortTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_port_templates_update parameters: - description: A UUID string identifying this console port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsolePortTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-port-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_console_port_templates_notes_list parameters: - description: A UUID string identifying this console port template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_console_port_templates_notes_create parameters: - description: A UUID string identifying this console port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-ports/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_list parameters: - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - description: Connected status (bool) in: query name: connected schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConsolePortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConsolePortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsolePort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsolePortRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConsolePortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsolePort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-ports/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_destroy parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_retrieve parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_partial_update parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsolePortRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_ports_update parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsolePortRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-ports/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_console_ports_notes_list parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_console_ports_notes_create parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-ports/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_console_ports_trace_retrieve parameters: - description: A UUID string identifying this console port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsolePort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-port-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConsoleServerPortTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConsoleServerPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsoleServerPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConsoleServerPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsoleServerPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-port-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_destroy parameters: - description: A UUID string identifying this console server port template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_retrieve parameters: - description: A UUID string identifying this console server port template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_partial_update parameters: - description: A UUID string identifying this console server port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsoleServerPortTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_port_templates_update parameters: - description: A UUID string identifying this console server port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsoleServerPortTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-port-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_console_server_port_templates_notes_list parameters: - description: A UUID string identifying this console server port template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_console_server_port_templates_notes_create parameters: - description: A UUID string identifying this console server port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-ports/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_list parameters: - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - description: Connected status (bool) in: query name: connected schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConsoleServerPortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConsoleServerPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsoleServerPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsoleServerPortRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConsoleServerPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConsoleServerPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-ports/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_destroy parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_retrieve parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_partial_update parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConsoleServerPortRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_console_server_ports_update parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConsoleServerPortRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-ports/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_console_server_ports_notes_list parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_console_server_ports_notes_create parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/console-server-ports/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_console_server_ports_trace_retrieve parameters: - description: A UUID string identifying this console server port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConsoleServerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-bay-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDeviceBayTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDeviceBayTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceBayTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceBayTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDeviceBayTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceBayTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-bay-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_destroy parameters: - description: A UUID string identifying this device bay template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_retrieve parameters: - description: A UUID string identifying this device bay template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_partial_update parameters: - description: A UUID string identifying this device bay template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceBayTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bay_templates_update parameters: - description: A UUID string identifying this device bay template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceBayTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBayTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-bay-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_device_bay_templates_notes_list parameters: - description: A UUID string identifying this device bay template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_device_bay_templates_notes_create parameters: - description: A UUID string identifying this device bay template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-bays/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_list parameters: - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Installed device (name or ID) explode: true in: query name: installed_device schema: items: format: uuid type: string type: array style: form - description: Installed device (name or ID) explode: true in: query name: installed_device__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDeviceBayList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDeviceBayRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceBay' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceBayRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBay' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDeviceBayRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceBay' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-bays/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_destroy parameters: - description: A UUID string identifying this device bay. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_retrieve parameters: - description: A UUID string identifying this device bay. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBay' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_partial_update parameters: - description: A UUID string identifying this device bay. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceBayRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBay' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_bays_update parameters: - description: A UUID string identifying this device bay. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceBayRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceBay' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-bays/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_device_bays_notes_list parameters: - description: A UUID string identifying this device bay. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_device_bays_notes_create parameters: - description: A UUID string identifying this device bay. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-redundancy-groups/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: failover_strategy schema: type: string - in: query name: failover_strategy__n schema: type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Secrets group explode: true in: query name: secrets_group schema: items: format: uuid type: string type: array style: form - description: Secrets group explode: true in: query name: secrets_group__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDeviceRedundancyGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDeviceRedundancyGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceRedundancyGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceRedundancyGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRedundancyGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDeviceRedundancyGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceRedundancyGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-redundancy-groups/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_destroy parameters: - description: A UUID string identifying this device redundancy group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_retrieve parameters: - description: A UUID string identifying this device redundancy group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRedundancyGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_partial_update parameters: - description: A UUID string identifying this device redundancy group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceRedundancyGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRedundancyGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_device_redundancy_groups_update parameters: - description: A UUID string identifying this device redundancy group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceRedundancyGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRedundancyGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-redundancy-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_device_redundancy_groups_notes_list parameters: - description: A UUID string identifying this device redundancy group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_device_redundancy_groups_notes_create parameters: - description: A UUID string identifying this device redundancy group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-roles/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_list parameters: - explode: true in: query name: color schema: items: type: string type: array style: form - explode: true in: query name: color__ic schema: items: type: string type: array style: form - explode: true in: query name: color__ie schema: items: type: string type: array style: form - explode: true in: query name: color__iew schema: items: type: string type: array style: form - explode: true in: query name: color__ire schema: items: type: string type: array style: form - explode: true in: query name: color__isw schema: items: type: string type: array style: form - explode: true in: query name: color__n schema: items: type: string type: array style: form - explode: true in: query name: color__nic schema: items: type: string type: array style: form - explode: true in: query name: color__nie schema: items: type: string type: array style: form - explode: true in: query name: color__niew schema: items: type: string type: array style: form - explode: true in: query name: color__nire schema: items: type: string type: array style: form - explode: true in: query name: color__nisw schema: items: type: string type: array style: form - explode: true in: query name: color__nre schema: items: type: string type: array style: form - explode: true in: query name: color__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: devices schema: items: format: uuid type: string type: array style: form - explode: true in: query name: devices__n schema: items: format: uuid type: string type: array style: form - description: Has devices in: query name: has_devices schema: type: boolean - description: Has virtual machines in: query name: has_virtual_machines schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: virtual_machines schema: items: format: uuid type: string type: array style: form - explode: true in: query name: virtual_machines__n schema: items: format: uuid type: string type: array style: form - in: query name: vm_role schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDeviceRoleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDeviceRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceRole' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_create requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceRoleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDeviceRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceRole' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-roles/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_destroy parameters: - description: A UUID string identifying this device role. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_retrieve parameters: - description: A UUID string identifying this device role. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_partial_update parameters: - description: A UUID string identifying this device role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDeviceRoleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_roles_update parameters: - description: A UUID string identifying this device role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DeviceRoleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-roles/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_device_roles_notes_list parameters: - description: A UUID string identifying this device role. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_device_roles_notes_create parameters: - description: A UUID string identifying this device role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-types/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_list parameters: - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - description: Console port templates (name or ID) explode: true in: query name: console_port_templates schema: items: format: uuid type: string type: array style: form - description: Console port templates (name or ID) explode: true in: query name: console_port_templates__n schema: items: format: uuid type: string type: array style: form - description: Has console ports in: query name: console_ports schema: type: boolean - description: Console server port templates (name or ID) explode: true in: query name: console_server_port_templates schema: items: format: uuid type: string type: array style: form - description: Console server port templates (name or ID) explode: true in: query name: console_server_port_templates__n schema: items: format: uuid type: string type: array style: form - description: Has console server ports in: query name: console_server_ports schema: type: boolean - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device bay templates explode: true in: query name: device_bay_templates schema: items: format: uuid type: string type: array style: form - description: Device bay templates explode: true in: query name: device_bay_templates__n schema: items: format: uuid type: string type: array style: form - description: Has device bays in: query name: device_bays schema: type: boolean - description: Front port templates (name or ID) explode: true in: query name: front_port_templates schema: items: format: uuid type: string type: array style: form - description: Front port templates (name or ID) explode: true in: query name: front_port_templates__n schema: items: format: uuid type: string type: array style: form - description: Has console port templates in: query name: has_console_port_templates schema: type: boolean - description: Has console server port templates in: query name: has_console_server_port_templates schema: type: boolean - description: Has device bay templates in: query name: has_device_bay_templates schema: type: boolean - description: Has front port templates in: query name: has_front_port_templates schema: type: boolean - description: Has instances in: query name: has_instances schema: type: boolean - description: Has interface templates in: query name: has_interface_templates schema: type: boolean - description: Has power outlet templates in: query name: has_power_outlet_templates schema: type: boolean - description: Has power port templates in: query name: has_power_port_templates schema: type: boolean - description: Has rear port templates in: query name: has_rear_port_templates schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: instances schema: items: format: uuid type: string type: array style: form - explode: true in: query name: instances__n schema: items: format: uuid type: string type: array style: form - description: Interface templates (name or ID) explode: true in: query name: interface_templates schema: items: format: uuid type: string type: array style: form - description: Interface templates (name or ID) explode: true in: query name: interface_templates__n schema: items: format: uuid type: string type: array style: form - description: Has interfaces in: query name: interfaces schema: type: boolean - in: query name: is_full_depth schema: type: boolean - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Manufacturer (slug) explode: true in: query name: manufacturer schema: items: type: string type: array style: form - description: Manufacturer (slug) explode: true in: query name: manufacturer__n schema: items: type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id schema: items: format: uuid type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: model schema: items: type: string type: array style: form - explode: true in: query name: model__ic schema: items: type: string type: array style: form - explode: true in: query name: model__ie schema: items: type: string type: array style: form - explode: true in: query name: model__iew schema: items: type: string type: array style: form - explode: true in: query name: model__ire schema: items: type: string type: array style: form - explode: true in: query name: model__isw schema: items: type: string type: array style: form - explode: true in: query name: model__n schema: items: type: string type: array style: form - explode: true in: query name: model__nic schema: items: type: string type: array style: form - explode: true in: query name: model__nie schema: items: type: string type: array style: form - explode: true in: query name: model__niew schema: items: type: string type: array style: form - explode: true in: query name: model__nire schema: items: type: string type: array style: form - explode: true in: query name: model__nisw schema: items: type: string type: array style: form - explode: true in: query name: model__nre schema: items: type: string type: array style: form - explode: true in: query name: model__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: part_number schema: items: type: string type: array style: form - explode: true in: query name: part_number__ic schema: items: type: string type: array style: form - explode: true in: query name: part_number__ie schema: items: type: string type: array style: form - explode: true in: query name: part_number__iew schema: items: type: string type: array style: form - explode: true in: query name: part_number__ire schema: items: type: string type: array style: form - explode: true in: query name: part_number__isw schema: items: type: string type: array style: form - explode: true in: query name: part_number__n schema: items: type: string type: array style: form - explode: true in: query name: part_number__nic schema: items: type: string type: array style: form - explode: true in: query name: part_number__nie schema: items: type: string type: array style: form - explode: true in: query name: part_number__niew schema: items: type: string type: array style: form - explode: true in: query name: part_number__nire schema: items: type: string type: array style: form - explode: true in: query name: part_number__nisw schema: items: type: string type: array style: form - explode: true in: query name: part_number__nre schema: items: type: string type: array style: form - explode: true in: query name: part_number__re schema: items: type: string type: array style: form - description: Has pass-through ports in: query name: pass_through_ports schema: type: boolean - description: Power outlet templates (name or ID) explode: true in: query name: power_outlet_templates schema: items: format: uuid type: string type: array style: form - description: Power outlet templates (name or ID) explode: true in: query name: power_outlet_templates__n schema: items: format: uuid type: string type: array style: form - description: Has power outlets in: query name: power_outlets schema: type: boolean - description: Power port templates (name or ID) explode: true in: query name: power_port_templates schema: items: format: uuid type: string type: array style: form - description: Power port templates (name or ID) explode: true in: query name: power_port_templates__n schema: items: format: uuid type: string type: array style: form - description: Has power ports in: query name: power_ports schema: type: boolean - description: Search in: query name: q schema: type: string - description: Rear port templates (name or ID) explode: true in: query name: rear_port_templates schema: items: format: uuid type: string type: array style: form - description: Rear port templates (name or ID) explode: true in: query name: rear_port_templates__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - description: Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. in: query name: subdevice_role schema: title: Parent/child status type: string - description: Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. in: query name: subdevice_role__n schema: title: Parent/child status type: string - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - explode: true in: query name: u_height schema: items: type: integer type: array style: form - explode: true in: query name: u_height__gt schema: items: type: integer type: array style: form - explode: true in: query name: u_height__gte schema: items: type: integer type: array style: form - explode: true in: query name: u_height__lt schema: items: type: integer type: array style: form - explode: true in: query name: u_height__lte schema: items: type: integer type: array style: form - explode: true in: query name: u_height__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDeviceTypeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDeviceTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceTypeRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDeviceTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-types/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_destroy parameters: - description: A UUID string identifying this device type. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_retrieve parameters: - description: A UUID string identifying this device type. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_partial_update parameters: - description: A UUID string identifying this device type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceTypeRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_device_types_update parameters: - description: A UUID string identifying this device type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceTypeRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/device-types/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_device_types_notes_list parameters: - description: A UUID string identifying this device type. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_device_types_notes_create parameters: - description: A UUID string identifying this device type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/devices/: delete: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_list parameters: - description: asset_tag in: query name: asset_tag required: false schema: type: string - description: asset_tag__ic in: query name: asset_tag__ic required: false schema: type: string - description: asset_tag__ie in: query name: asset_tag__ie required: false schema: type: string - description: asset_tag__iew in: query name: asset_tag__iew required: false schema: type: string - description: asset_tag__ire in: query name: asset_tag__ire required: false schema: type: string - description: asset_tag__isw in: query name: asset_tag__isw required: false schema: type: string - description: asset_tag__n in: query name: asset_tag__n required: false schema: type: string - description: asset_tag__nic in: query name: asset_tag__nic required: false schema: type: string - description: asset_tag__nie in: query name: asset_tag__nie required: false schema: type: string - description: asset_tag__niew in: query name: asset_tag__niew required: false schema: type: string - description: asset_tag__nire in: query name: asset_tag__nire required: false schema: type: string - description: asset_tag__nisw in: query name: asset_tag__nisw required: false schema: type: string - description: asset_tag__nre in: query name: asset_tag__nre required: false schema: type: string - description: asset_tag__re in: query name: asset_tag__re required: false schema: type: string - description: VM cluster (ID) in: query name: cluster_id required: false schema: type: string - description: VM cluster (ID) in: query name: cluster_id__n required: false schema: type: string - description: Has console ports in: query name: console_ports required: false schema: type: string - description: Has console server ports in: query name: console_server_ports required: false schema: type: string - description: created in: query name: created required: false schema: type: string - description: created__gte in: query name: created__gte required: false schema: type: string - description: created__lte in: query name: created__lte required: false schema: type: string - description: Has device bays in: query name: device_bays required: false schema: type: string - description: Device Redundancy Groups (slug or ID) in: query name: device_redundancy_group required: false schema: type: string - description: Device Redundancy Groups (slug or ID) in: query name: device_redundancy_group__n required: false schema: type: string - description: device_redundancy_group_priority in: query name: device_redundancy_group_priority required: false schema: type: string - description: device_redundancy_group_priority__gt in: query name: device_redundancy_group_priority__gt required: false schema: type: string - description: device_redundancy_group_priority__gte in: query name: device_redundancy_group_priority__gte required: false schema: type: string - description: device_redundancy_group_priority__lt in: query name: device_redundancy_group_priority__lt required: false schema: type: string - description: device_redundancy_group_priority__lte in: query name: device_redundancy_group_priority__lte required: false schema: type: string - description: device_redundancy_group_priority__n in: query name: device_redundancy_group_priority__n required: false schema: type: string - description: Device type (ID) in: query name: device_type_id required: false schema: type: string - description: Device type (ID) in: query name: device_type_id__n required: false schema: type: string - description: face in: query name: face required: false schema: enum: - front - rear type: string - description: face__n in: query name: face__n required: false schema: enum: - front - rear type: string - description: Has console ports in: query name: has_console_ports required: false schema: type: string - description: Has console server ports in: query name: has_console_server_ports required: false schema: type: string - description: Has device bays in: query name: has_device_bays required: false schema: type: string - description: Has front ports in: query name: has_front_ports required: false schema: type: string - description: Has interfaces in: query name: has_interfaces required: false schema: type: string - description: Has power outlets in: query name: has_power_outlets required: false schema: type: string - description: Has power ports in: query name: has_power_ports required: false schema: type: string - description: Has a primary IP in: query name: has_primary_ip required: false schema: type: string - description: Has rear ports in: query name: has_rear_ports required: false schema: type: string - description: id in: query name: id required: false schema: type: string - description: id__ic in: query name: id__ic required: false schema: type: string - description: id__ie in: query name: id__ie required: false schema: type: string - description: id__iew in: query name: id__iew required: false schema: type: string - description: id__ire in: query name: id__ire required: false schema: type: string - description: id__isw in: query name: id__isw required: false schema: type: string - description: id__n in: query name: id__n required: false schema: type: string - description: id__nic in: query name: id__nic required: false schema: type: string - description: id__nie in: query name: id__nie required: false schema: type: string - description: id__niew in: query name: id__niew required: false schema: type: string - description: id__nire in: query name: id__nire required: false schema: type: string - description: id__nisw in: query name: id__nisw required: false schema: type: string - description: id__nre in: query name: id__nre required: false schema: type: string - description: id__re in: query name: id__re required: false schema: type: string - description: Has interfaces in: query name: interfaces required: false schema: type: string - description: Is full depth in: query name: is_full_depth required: false schema: type: string - description: Is a virtual chassis member in: query name: is_virtual_chassis_member required: false schema: type: string - description: last_updated in: query name: last_updated required: false schema: type: string - description: last_updated__gte in: query name: last_updated__gte required: false schema: type: string - description: last_updated__lte in: query name: last_updated__lte required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Has local config context data in: query name: local_context_data required: false schema: type: string - description: Schema (slug) in: query name: local_context_schema required: false schema: type: string - description: Schema (slug) in: query name: local_context_schema__n required: false schema: type: string - description: Schema (ID) in: query name: local_context_schema_id required: false schema: type: string - description: Schema (ID) in: query name: local_context_schema_id__n required: false schema: type: string - description: Location (slug or ID) in: query name: location required: false schema: type: string - description: Location (slug or ID) in: query name: location__n required: false schema: type: string - description: MAC address in: query name: mac_address required: false schema: type: string - description: MAC address in: query name: mac_address__ic required: false schema: type: string - description: MAC address in: query name: mac_address__ie required: false schema: type: string - description: MAC address in: query name: mac_address__iew required: false schema: type: string - description: MAC address in: query name: mac_address__ire required: false schema: type: string - description: MAC address in: query name: mac_address__isw required: false schema: type: string - description: MAC address in: query name: mac_address__n required: false schema: type: string - description: MAC address in: query name: mac_address__nic required: false schema: type: string - description: MAC address in: query name: mac_address__nie required: false schema: type: string - description: MAC address in: query name: mac_address__niew required: false schema: type: string - description: MAC address in: query name: mac_address__nire required: false schema: type: string - description: MAC address in: query name: mac_address__nisw required: false schema: type: string - description: MAC address in: query name: mac_address__nre required: false schema: type: string - description: MAC address in: query name: mac_address__re required: false schema: type: string - description: Manufacturer (slug) in: query name: manufacturer required: false schema: type: string - description: Manufacturer (slug) in: query name: manufacturer__n required: false schema: type: string - description: Manufacturer (ID) in: query name: manufacturer_id required: false schema: type: string - description: Manufacturer (ID) in: query name: manufacturer_id__n required: false schema: type: string - description: Device model (slug) in: query name: model required: false schema: type: string - description: Device model (slug) in: query name: model__n required: false schema: type: string - description: name in: query name: name required: false schema: type: string - description: name__ic in: query name: name__ic required: false schema: type: string - description: name__ie in: query name: name__ie required: false schema: type: string - description: name__iew in: query name: name__iew required: false schema: type: string - description: name__ire in: query name: name__ire required: false schema: type: string - description: name__isw in: query name: name__isw required: false schema: type: string - description: name__n in: query name: name__n required: false schema: type: string - description: name__nic in: query name: name__nic required: false schema: type: string - description: name__nie in: query name: name__nie required: false schema: type: string - description: name__niew in: query name: name__niew required: false schema: type: string - description: name__nire in: query name: name__nire required: false schema: type: string - description: name__nisw in: query name: name__nisw required: false schema: type: string - description: name__nre in: query name: name__nre required: false schema: type: string - description: name__re in: query name: name__re required: false schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Has pass-through ports in: query name: pass_through_ports required: false schema: type: string - description: Platform (slug) in: query name: platform required: false schema: type: string - description: Platform (slug) in: query name: platform__n required: false schema: type: string - description: Platform (ID) in: query name: platform_id required: false schema: type: string - description: Platform (ID) in: query name: platform_id__n required: false schema: type: string - description: position in: query name: position required: false schema: type: string - description: position__gt in: query name: position__gt required: false schema: type: string - description: position__gte in: query name: position__gte required: false schema: type: string - description: position__lt in: query name: position__lt required: false schema: type: string - description: position__lte in: query name: position__lte required: false schema: type: string - description: position__n in: query name: position__n required: false schema: type: string - description: Has power outlets in: query name: power_outlets required: false schema: type: string - description: Has power ports in: query name: power_ports required: false schema: type: string - description: Search in: query name: q required: false schema: type: string - description: Rack group (ID) in: query name: rack_group_id required: false schema: type: string - description: Rack group (ID) in: query name: rack_group_id__n required: false schema: type: string - description: Rack (ID) in: query name: rack_id required: false schema: type: string - description: Rack (ID) in: query name: rack_id__n required: false schema: type: string - description: Region (slug or ID) in: query name: region required: false schema: type: string - description: Region (slug or ID) in: query name: region__n required: false schema: type: string - description: Region (ID) (deprecated, use "region" filter instead) in: query name: region_id required: false schema: type: string - description: Region (ID) (deprecated, use "region" filter instead) in: query name: region_id__n required: false schema: type: string - description: Role (slug) in: query name: role required: false schema: type: string - description: Role (slug) in: query name: role__n required: false schema: type: string - description: Role (ID) in: query name: role_id required: false schema: type: string - description: Role (ID) in: query name: role_id__n required: false schema: type: string - description: Secrets group (slug) in: query name: secrets_group required: false schema: type: string - description: Secrets group (slug) in: query name: secrets_group__n required: false schema: type: string - description: Secrets group (ID) in: query name: secrets_group_id required: false schema: type: string - description: Secrets group (ID) in: query name: secrets_group_id__n required: false schema: type: string - description: serial in: query name: serial required: false schema: type: string - description: Site (slug or ID) in: query name: site required: false schema: type: string - description: Site (slug or ID) in: query name: site__n required: false schema: type: string - description: Site (ID) (deprecated, use "site" filter instead) in: query name: site_id required: false schema: type: string - description: Site (ID) (deprecated, use "site" filter instead) in: query name: site_id__n required: false schema: type: string - description: status in: query name: status required: false schema: type: string - description: status__n in: query name: status__n required: false schema: type: string - description: tag in: query name: tag required: false schema: type: string - description: tag__n in: query name: tag__n required: false schema: type: string - description: Tenant (slug or ID) in: query name: tenant required: false schema: type: string - description: Tenant (slug or ID) in: query name: tenant__n required: false schema: type: string - description: Tenant Group (slug) in: query name: tenant_group required: false schema: type: string - description: Tenant Group (slug) in: query name: tenant_group__n required: false schema: type: string - description: Tenant Group (ID) in: query name: tenant_group_id required: false schema: type: string - description: Tenant Group (ID) in: query name: tenant_group_id__n required: false schema: type: string - description: Tenant (ID) (deprecated, use "tenant" filter instead) in: query name: tenant_id required: false schema: type: string - description: Tenant (ID) (deprecated, use "tenant" filter instead) in: query name: tenant_id__n required: false schema: type: string - description: vc_position in: query name: vc_position required: false schema: type: string - description: vc_position__gt in: query name: vc_position__gt required: false schema: type: string - description: vc_position__gte in: query name: vc_position__gte required: false schema: type: string - description: vc_position__lt in: query name: vc_position__lt required: false schema: type: string - description: vc_position__lte in: query name: vc_position__lte required: false schema: type: string - description: vc_position__n in: query name: vc_position__n required: false schema: type: string - description: vc_priority in: query name: vc_priority required: false schema: type: string - description: vc_priority__gt in: query name: vc_priority__gt required: false schema: type: string - description: vc_priority__gte in: query name: vc_priority__gte required: false schema: type: string - description: vc_priority__lt in: query name: vc_priority__lt required: false schema: type: string - description: vc_priority__lte in: query name: vc_priority__lte required: false schema: type: string - description: vc_priority__n in: query name: vc_priority__n required: false schema: type: string - description: Virtual chassis (ID) in: query name: virtual_chassis_id required: false schema: type: string - description: Virtual chassis (ID) in: query name: virtual_chassis_id__n required: false schema: type: string - description: Is a virtual chassis member in: query name: virtual_chassis_member required: false schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDeviceWithConfigContextList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDeviceWithConfigContextRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceWithConfigContext' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDeviceWithConfigContextRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DeviceWithConfigContext' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/devices/{id}/: delete: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_destroy parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_retrieve parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_partial_update parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDeviceWithConfigContextRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: dcim_devices_update parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDeviceWithConfigContextRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/devices/{id}/napalm/: get: description: Execute a NAPALM method on a Device operationId: dcim_devices_napalm_retrieve parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string - in: query name: method required: true schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DeviceNAPALM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/devices/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_devices_notes_list parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_devices_notes_create parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-port-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: rear_port_position schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__gt schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__gte schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__lt schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__lte schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__n schema: items: type: integer type: array style: form - description: Rear port template explode: true in: query name: rear_port_template schema: items: format: uuid type: string type: array style: form - description: Rear port template explode: true in: query name: rear_port_template__n schema: items: format: uuid type: string type: array style: form - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedFrontPortTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableFrontPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/FrontPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFrontPortTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableFrontPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/FrontPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-port-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_destroy parameters: - description: A UUID string identifying this front port template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_retrieve parameters: - description: A UUID string identifying this front port template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_partial_update parameters: - description: A UUID string identifying this front port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableFrontPortTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_port_templates_update parameters: - description: A UUID string identifying this front port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFrontPortTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-port-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_front_port_templates_notes_list parameters: - description: A UUID string identifying this front port template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_front_port_templates_notes_create parameters: - description: A UUID string identifying this front port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-ports/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_list parameters: - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Rear port (name or ID) explode: true in: query name: rear_port schema: items: format: uuid type: string type: array style: form - description: Rear port (name or ID) explode: true in: query name: rear_port__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: rear_port_position schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__gt schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__gte schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__lt schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__lte schema: items: type: integer type: array style: form - explode: true in: query name: rear_port_position__n schema: items: type: integer type: array style: form - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedFrontPortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableFrontPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/FrontPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFrontPortRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableFrontPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/FrontPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-ports/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_destroy parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_retrieve parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_partial_update parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableFrontPortRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_front_ports_update parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFrontPortRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-ports/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_front_ports_notes_list parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_front_ports_notes_create parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/front-ports/{id}/paths/: get: description: Return all CablePaths which traverse a given pass-through port. operationId: dcim_front_ports_paths_retrieve parameters: - description: A UUID string identifying this front port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FrontPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interface-connections/: get: operationId: dcim_interface_connections_list parameters: - description: Device (name) explode: true in: query name: device schema: items: type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Site (slug) in: query name: site schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedInterfaceConnectionList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interface-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: mgmt_only schema: type: boolean - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedInterfaceTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableInterfaceTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/InterfaceTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInterfaceTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableInterfaceTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/InterfaceTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interface-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_destroy parameters: - description: A UUID string identifying this interface template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_retrieve parameters: - description: A UUID string identifying this interface template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_partial_update parameters: - description: A UUID string identifying this interface template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableInterfaceTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interface_templates_update parameters: - description: A UUID string identifying this interface template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInterfaceTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interface-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_interface_templates_notes_list parameters: - description: A UUID string identifying this interface template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_interface_templates_notes_create parameters: - description: A UUID string identifying this interface template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interfaces/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_list parameters: - description: Bridge interface (name or ID) explode: true in: query name: bridge schema: items: format: uuid type: string type: array style: form - description: Bridge interface (name or ID) explode: true in: query name: bridge__n schema: items: format: uuid type: string type: array style: form - description: Bridged interfaces (name or ID) explode: true in: query name: bridged_interfaces schema: items: format: uuid type: string type: array style: form - description: Bridged interfaces (name or ID) explode: true in: query name: bridged_interfaces__n schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - description: Child interfaces (name or ID) explode: true in: query name: child_interfaces schema: items: format: uuid type: string type: array style: form - description: Child interfaces (name or ID) explode: true in: query name: child_interfaces__n schema: items: format: uuid type: string type: array style: form - description: Connected status (bool) in: query name: connected schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Virtual Chassis member Device (ID) in: query name: device_with_common_vc schema: format: uuid type: string - in: query name: enabled schema: type: boolean - description: Has bridged interfaces in: query name: has_bridged_interfaces schema: type: boolean - description: Has child interfaces in: query name: has_child_interfaces schema: type: boolean - description: Has member interfaces in: query name: has_member_interfaces schema: type: boolean - description: Has tagged VLANs in: query name: has_tagged_vlans schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Kind of interface in: query name: kind schema: type: string - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: LAG interface (name or ID) explode: true in: query name: lag schema: items: format: uuid type: string type: array style: form - description: LAG interface (name or ID) explode: true in: query name: lag__n schema: items: format: uuid type: string type: array style: form - description: LAG interface (ID) explode: true in: query name: lag_id schema: items: format: uuid type: string type: array style: form - description: LAG interface (ID) explode: true in: query name: lag_id__n schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: mac_address schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__ic schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__ie schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__iew schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__ire schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__isw schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__n schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__nic schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__nie schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__niew schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__nire schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__nisw schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__nre schema: items: nullable: true type: string type: array style: form - explode: true in: query name: mac_address__re schema: items: nullable: true type: string type: array style: form - description: Member interfaces (name or ID) explode: true in: query name: member_interfaces schema: items: format: uuid type: string type: array style: form - description: Member interfaces (name or ID) explode: true in: query name: member_interfaces__n schema: items: format: uuid type: string type: array style: form - in: query name: mgmt_only schema: type: boolean - in: query name: mode schema: type: string - in: query name: mode__n schema: type: string - explode: true in: query name: mtu schema: items: type: integer type: array style: form - explode: true in: query name: mtu__gt schema: items: type: integer type: array style: form - explode: true in: query name: mtu__gte schema: items: type: integer type: array style: form - explode: true in: query name: mtu__lt schema: items: type: integer type: array style: form - explode: true in: query name: mtu__lte schema: items: type: integer type: array style: form - explode: true in: query name: mtu__n schema: items: type: integer type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: Routing Instance UUID explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance schema: items: type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_interfaces_bgp_routing_instance__re schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent interface (name or ID) explode: true in: query name: parent_interface schema: items: format: uuid type: string type: array style: form - description: Parent interface (name or ID) explode: true in: query name: parent_interface__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tagged VLANs (VID or ID) explode: true in: query name: tagged_vlans schema: items: format: uuid type: string type: array style: form - description: Tagged VLANs (VID or ID) explode: true in: query name: tagged_vlans__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: type schema: items: type: string type: array style: form - explode: true in: query name: type__n schema: items: type: string type: array style: form - description: Untagged VLAN (VID or ID) explode: true in: query name: untagged_vlan schema: items: format: uuid type: string type: array style: form - description: Untagged VLAN (VID or ID) explode: true in: query name: untagged_vlan__n schema: items: format: uuid type: string type: array style: form - description: Assigned VID in: query name: vlan schema: type: number - description: Assigned VLAN in: query name: vlan_id schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedInterfaceSerializerVersion12List' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableInterfaceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/InterfaceSerializerVersion12' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInterfaceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableInterfaceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/InterfaceSerializerVersion12' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interfaces/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_destroy parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_retrieve parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_partial_update parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableInterfaceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_interfaces_update parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInterfaceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interfaces/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_interfaces_notes_list parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_interfaces_notes_create parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/interfaces/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_interfaces_trace_retrieve parameters: - description: A UUID string identifying this interface. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Interface' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/inventory-items/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_list parameters: - explode: true in: query name: asset_tag schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ic schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ie schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__iew schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ire schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__isw schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__n schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nic schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nie schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__niew schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nire schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nisw schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nre schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__re schema: items: type: string type: array style: form - description: Child items (name or ID) explode: true in: query name: child_items schema: items: format: uuid type: string type: array style: form - description: Child items (name or ID) explode: true in: query name: child_items__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) in: query name: device schema: format: uuid type: string - description: Device (name) in: query name: device__n schema: format: uuid type: string - description: Device (ID) in: query name: device_id schema: format: uuid type: string - description: Device (ID) in: query name: device_id__n schema: format: uuid type: string - in: query name: discovered schema: type: boolean - description: Has child items in: query name: has_child_items schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Manufacturer (slug) explode: true in: query name: manufacturer schema: items: type: string type: array style: form - description: Manufacturer (slug) explode: true in: query name: manufacturer__n schema: items: type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent (name or ID) explode: true in: query name: parent schema: items: format: uuid type: string type: array style: form - description: Parent (name or ID) explode: true in: query name: parent__n schema: items: format: uuid type: string type: array style: form - description: Parent inventory item (ID) explode: true in: query name: parent_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Parent inventory item (ID) explode: true in: query name: parent_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: part_id schema: items: type: string type: array style: form - explode: true in: query name: part_id__ic schema: items: type: string type: array style: form - explode: true in: query name: part_id__ie schema: items: type: string type: array style: form - explode: true in: query name: part_id__iew schema: items: type: string type: array style: form - explode: true in: query name: part_id__ire schema: items: type: string type: array style: form - explode: true in: query name: part_id__isw schema: items: type: string type: array style: form - explode: true in: query name: part_id__n schema: items: type: string type: array style: form - explode: true in: query name: part_id__nic schema: items: type: string type: array style: form - explode: true in: query name: part_id__nie schema: items: type: string type: array style: form - explode: true in: query name: part_id__niew schema: items: type: string type: array style: form - explode: true in: query name: part_id__nire schema: items: type: string type: array style: form - explode: true in: query name: part_id__nisw schema: items: type: string type: array style: form - explode: true in: query name: part_id__nre schema: items: type: string type: array style: form - explode: true in: query name: part_id__re schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - in: query name: serial schema: type: string - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedInventoryItemList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableInventoryItemRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/InventoryItem' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInventoryItemRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InventoryItem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableInventoryItemRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/InventoryItem' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/inventory-items/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_destroy parameters: - description: A UUID string identifying this inventory item. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_retrieve parameters: - description: A UUID string identifying this inventory item. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InventoryItem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_partial_update parameters: - description: A UUID string identifying this inventory item. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableInventoryItemRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InventoryItem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_inventory_items_update parameters: - description: A UUID string identifying this inventory item. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableInventoryItemRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/InventoryItem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/inventory-items/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_inventory_items_notes_list parameters: - description: A UUID string identifying this inventory item. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_inventory_items_notes_create parameters: - description: A UUID string identifying this inventory item. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/location-types/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_list parameters: - explode: true in: query name: content_types schema: items: type: integer type: array style: form - explode: true in: query name: content_types__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - in: query name: nestable schema: type: boolean - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent location type (slug or ID) explode: true in: query name: parent schema: items: format: uuid type: string type: array style: form - description: Parent location type (slug or ID) explode: true in: query name: parent__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedLocationTypeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableLocationTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/LocationType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableLocationTypeRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/LocationType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableLocationTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/LocationType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/location-types/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_destroy parameters: - description: A UUID string identifying this location type. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_retrieve parameters: - description: A UUID string identifying this location type. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/LocationType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_partial_update parameters: - description: A UUID string identifying this location type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableLocationTypeRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/LocationType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_location_types_update parameters: - description: A UUID string identifying this location type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableLocationTypeRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/LocationType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/location-types/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_location_types_notes_list parameters: - description: A UUID string identifying this location type. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_location_types_notes_create parameters: - description: A UUID string identifying this location type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/locations/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_list parameters: - description: Base location's site (slug or ID) explode: true in: query name: base_site schema: items: type: string type: array style: form - description: Child location type (slug or ID) explode: true in: query name: child_location_type schema: items: type: string type: array style: form - explode: true in: query name: content_type schema: items: type: integer type: array style: form - explode: true in: query name: content_type__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location type (slug or ID) explode: true in: query name: location_type schema: items: format: uuid type: string type: array style: form - description: Location type (slug or ID) explode: true in: query name: location_type__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent location (slug or ID) explode: true in: query name: parent schema: items: format: uuid type: string type: array style: form - description: Parent location (slug or ID) explode: true in: query name: parent__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - description: Location(s) and descendants thereof (slug or ID) explode: true in: query name: subtree schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedLocationList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableLocationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Location' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableLocationRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Location' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableLocationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Location' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/locations/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_destroy parameters: - description: A UUID string identifying this location. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_retrieve parameters: - description: A UUID string identifying this location. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Location' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_partial_update parameters: - description: A UUID string identifying this location. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableLocationRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Location' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_locations_update parameters: - description: A UUID string identifying this location. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableLocationRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Location' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/locations/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_locations_notes_list parameters: - description: A UUID string identifying this location. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_locations_notes_create parameters: - description: A UUID string identifying this location. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/manufacturers/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device types (slug or ID) explode: true in: query name: device_types schema: items: format: uuid type: string type: array style: form - description: Device types (slug or ID) explode: true in: query name: device_types__n schema: items: format: uuid type: string type: array style: form - description: Has device types in: query name: has_device_types schema: type: boolean - description: Has inventory items in: query name: has_inventory_items schema: type: boolean - description: Has platforms in: query name: has_platforms schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Inventory items (name or ID) explode: true in: query name: inventory_items schema: items: format: uuid type: string type: array style: form - description: Inventory items (name or ID) explode: true in: query name: inventory_items__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platforms (slug or ID) explode: true in: query name: platforms schema: items: format: uuid type: string type: array style: form - description: Platforms (slug or ID) explode: true in: query name: platforms__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedManufacturerList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableManufacturerRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Manufacturer' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ManufacturerRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Manufacturer' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableManufacturerRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Manufacturer' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/manufacturers/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_destroy parameters: - description: A UUID string identifying this manufacturer. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_retrieve parameters: - description: A UUID string identifying this manufacturer. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Manufacturer' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_partial_update parameters: - description: A UUID string identifying this manufacturer. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedManufacturerRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Manufacturer' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_manufacturers_update parameters: - description: A UUID string identifying this manufacturer. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ManufacturerRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Manufacturer' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/manufacturers/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_manufacturers_notes_list parameters: - description: A UUID string identifying this manufacturer. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_manufacturers_notes_create parameters: - description: A UUID string identifying this manufacturer. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/platforms/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: devices schema: items: format: uuid type: string type: array style: form - explode: true in: query name: devices__n schema: items: format: uuid type: string type: array style: form - description: Has devices in: query name: has_devices schema: type: boolean - description: Has virtual machines in: query name: has_virtual_machines schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Manufacturer (slug) explode: true in: query name: manufacturer schema: items: type: string type: array style: form - description: Manufacturer (slug) explode: true in: query name: manufacturer__n schema: items: type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id schema: items: format: uuid type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - explode: true in: query name: napalm_args schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__ic schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__ie schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__iew schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__ire schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__isw schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__n schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__nic schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__nie schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__niew schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__nire schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__nisw schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__nre schema: items: type: string type: array style: form - explode: true in: query name: napalm_driver__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: virtual_machines schema: items: format: uuid type: string type: array style: form - explode: true in: query name: virtual_machines__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPlatformList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePlatformRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Platform' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePlatformRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Platform' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePlatformRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Platform' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/platforms/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_destroy parameters: - description: A UUID string identifying this platform. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_retrieve parameters: - description: A UUID string identifying this platform. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Platform' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_partial_update parameters: - description: A UUID string identifying this platform. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePlatformRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Platform' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_platforms_update parameters: - description: A UUID string identifying this platform. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePlatformRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Platform' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/platforms/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_platforms_notes_list parameters: - description: A UUID string identifying this platform. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_platforms_notes_create parameters: - description: A UUID string identifying this platform. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-connections/: get: operationId: dcim_power_connections_list parameters: - description: Device (name) explode: true in: query name: device schema: items: type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Site (slug) in: query name: site schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerPortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-feeds/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_list parameters: - explode: true in: query name: amperage schema: items: type: integer type: array style: form - explode: true in: query name: amperage__gt schema: items: type: integer type: array style: form - explode: true in: query name: amperage__gte schema: items: type: integer type: array style: form - explode: true in: query name: amperage__lt schema: items: type: integer type: array style: form - explode: true in: query name: amperage__lte schema: items: type: integer type: array style: form - explode: true in: query name: amperage__n schema: items: type: integer type: array style: form - explode: true in: query name: available_power schema: items: type: integer type: array style: form - explode: true in: query name: available_power__gt schema: items: type: integer type: array style: form - explode: true in: query name: available_power__gte schema: items: type: integer type: array style: form - explode: true in: query name: available_power__lt schema: items: type: integer type: array style: form - explode: true in: query name: available_power__lte schema: items: type: integer type: array style: form - explode: true in: query name: available_power__n schema: items: type: integer type: array style: form - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - description: Connected status (bool) in: query name: connected schema: type: boolean - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: max_utilization schema: items: type: integer type: array style: form - explode: true in: query name: max_utilization__gt schema: items: type: integer type: array style: form - explode: true in: query name: max_utilization__gte schema: items: type: integer type: array style: form - explode: true in: query name: max_utilization__lt schema: items: type: integer type: array style: form - explode: true in: query name: max_utilization__lte schema: items: type: integer type: array style: form - explode: true in: query name: max_utilization__n schema: items: type: integer type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: phase schema: type: string - in: query name: phase__n schema: type: string - description: Power panel (name or ID) explode: true in: query name: power_panel schema: items: format: uuid type: string type: array style: form - description: Power panel (name or ID) explode: true in: query name: power_panel__n schema: items: format: uuid type: string type: array style: form - description: Power panel (ID) explode: true in: query name: power_panel_id schema: items: format: uuid type: string type: array style: form - description: Power panel (ID) explode: true in: query name: power_panel_id__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Rack (name or ID) explode: true in: query name: rack schema: items: format: uuid type: string type: array style: form - description: Rack (name or ID) explode: true in: query name: rack__n schema: items: format: uuid type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id schema: items: format: uuid type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id__n schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - in: query name: supply schema: type: string - in: query name: supply__n schema: type: string - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - in: query name: type schema: type: string - in: query name: type__n schema: type: string - explode: true in: query name: voltage schema: items: type: integer type: array style: form - explode: true in: query name: voltage__gt schema: items: type: integer type: array style: form - explode: true in: query name: voltage__gte schema: items: type: integer type: array style: form - explode: true in: query name: voltage__lt schema: items: type: integer type: array style: form - explode: true in: query name: voltage__lte schema: items: type: integer type: array style: form - explode: true in: query name: voltage__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerFeedList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePowerFeedRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerFeed' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerFeedRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerFeed' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePowerFeedRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerFeed' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-feeds/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_destroy parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_retrieve parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerFeed' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_partial_update parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerFeedRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerFeed' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_power_feeds_update parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerFeedRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerFeed' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-feeds/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_power_feeds_notes_list parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_power_feeds_notes_create parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-feeds/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_power_feeds_trace_retrieve parameters: - description: A UUID string identifying this power feed. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerFeed' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlet-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: Phase (for three-phase feeds) in: query name: feed_leg schema: type: string - description: Phase (for three-phase feeds) in: query name: feed_leg__n schema: type: string - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Power port template (name or ID) explode: true in: query name: power_port_template schema: items: format: uuid type: string type: array style: form - description: Power port template (name or ID) explode: true in: query name: power_port_template__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerOutletTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePowerOutletTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerOutletTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePowerOutletTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerOutletTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlet-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_destroy parameters: - description: A UUID string identifying this power outlet template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_retrieve parameters: - description: A UUID string identifying this power outlet template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_partial_update parameters: - description: A UUID string identifying this power outlet template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerOutletTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlet_templates_update parameters: - description: A UUID string identifying this power outlet template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerOutletTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutletTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlet-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_power_outlet_templates_notes_list parameters: - description: A UUID string identifying this power outlet template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_power_outlet_templates_notes_create parameters: - description: A UUID string identifying this power outlet template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlets/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_list parameters: - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - description: Connected status (bool) in: query name: connected schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - description: Phase (for three-phase feeds) in: query name: feed_leg schema: type: string - description: Phase (for three-phase feeds) in: query name: feed_leg__n schema: type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Power port explode: true in: query name: power_port schema: items: format: uuid type: string type: array style: form - description: Power port explode: true in: query name: power_port__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerOutletList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePowerOutletRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerOutlet' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerOutletRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutlet' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePowerOutletRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerOutlet' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlets/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_destroy parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_retrieve parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutlet' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_partial_update parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerOutletRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutlet' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_outlets_update parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerOutletRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutlet' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlets/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_power_outlets_notes_list parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_power_outlets_notes_create parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-outlets/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_power_outlets_trace_retrieve parameters: - description: A UUID string identifying this power outlet. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerOutlet' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-panels/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Has power feeds in: query name: has_power_feeds schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Power feeds (name or ID) explode: true in: query name: power_feeds schema: items: format: uuid type: string type: array style: form - description: Power feeds (name or ID) explode: true in: query name: power_feeds__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Rack group (slug or ID) explode: true in: query name: rack_group schema: items: format: uuid type: string type: array style: form - description: Rack group (slug or ID) explode: true in: query name: rack_group__n schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: rack_group_id schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: rack_group_id__n schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerPanelList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePowerPanelRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerPanel' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPanelRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPanel' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePowerPanelRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerPanel' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-panels/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_destroy parameters: - description: A UUID string identifying this power panel. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_retrieve parameters: - description: A UUID string identifying this power panel. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPanel' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_partial_update parameters: - description: A UUID string identifying this power panel. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerPanelRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPanel' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_panels_update parameters: - description: A UUID string identifying this power panel. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPanelRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPanel' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-panels/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_power_panels_notes_list parameters: - description: A UUID string identifying this power panel. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_power_panels_notes_create parameters: - description: A UUID string identifying this power panel. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-port-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_list parameters: - explode: true in: query name: allocated_draw schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__gt schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__gte schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__lt schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__lte schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__n schema: items: type: integer type: array style: form - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: Has power outlet templates in: query name: has_power_outlet_templates schema: type: boolean - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: maximum_draw schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__gt schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__gte schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__lt schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__lte schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__n schema: items: type: integer type: array style: form - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Power outlet templates (name or ID) explode: true in: query name: power_outlet_templates schema: items: format: uuid type: string type: array style: form - description: Power outlet templates (name or ID) explode: true in: query name: power_outlet_templates__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerPortTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePowerPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPortTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePowerPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-port-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_destroy parameters: - description: A UUID string identifying this power port template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_retrieve parameters: - description: A UUID string identifying this power port template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_partial_update parameters: - description: A UUID string identifying this power port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerPortTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_port_templates_update parameters: - description: A UUID string identifying this power port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPortTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-port-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_power_port_templates_notes_list parameters: - description: A UUID string identifying this power port template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_power_port_templates_notes_create parameters: - description: A UUID string identifying this power port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-ports/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_list parameters: - explode: true in: query name: allocated_draw schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__gt schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__gte schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__lt schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__lte schema: items: type: integer type: array style: form - explode: true in: query name: allocated_draw__n schema: items: type: integer type: array style: form - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - description: Connected status (bool) in: query name: connected schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - description: Has power outlets in: query name: has_power_outlets schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: maximum_draw schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__gt schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__gte schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__lt schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__lte schema: items: type: integer type: array style: form - explode: true in: query name: maximum_draw__n schema: items: type: integer type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Power outlets (name or ID) explode: true in: query name: power_outlets schema: items: format: uuid type: string type: array style: form - description: Power outlets (name or ID) explode: true in: query name: power_outlets__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type schema: items: type: string type: array style: form - description: Physical port type explode: true in: query name: type__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPowerPortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePowerPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPortRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePowerPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PowerPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-ports/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_destroy parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_retrieve parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_partial_update parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePowerPortRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_power_ports_update parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePowerPortRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-ports/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_power_ports_notes_list parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_power_ports_notes_create parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/power-ports/{id}/trace/: get: description: Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination). operationId: dcim_power_ports_trace_retrieve parameters: - description: A UUID string identifying this power port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PowerPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-groups/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_list parameters: - description: Children (slug or ID) explode: true in: query name: children schema: items: format: uuid type: string type: array style: form - description: Children (slug or ID) explode: true in: query name: children__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Has children in: query name: has_children schema: type: boolean - description: Has power panels in: query name: has_power_panels schema: type: boolean - description: Has racks in: query name: has_racks schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent (slug) explode: true in: query name: parent schema: items: type: string type: array style: form - description: Parent (slug) explode: true in: query name: parent__n schema: items: type: string type: array style: form - description: Parent (ID) explode: true in: query name: parent_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Parent (ID) explode: true in: query name: parent_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Power panels (name or ID) explode: true in: query name: power_panels schema: items: format: uuid type: string type: array style: form - description: Power panels (name or ID) explode: true in: query name: power_panels__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: racks schema: items: format: uuid type: string type: array style: form - explode: true in: query name: racks__n schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRackGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRackGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RackGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRackGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RackGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-groups/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_destroy parameters: - description: A UUID string identifying this rack group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_retrieve parameters: - description: A UUID string identifying this rack group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_partial_update parameters: - description: A UUID string identifying this rack group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRackGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_groups_update parameters: - description: A UUID string identifying this rack group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_rack_groups_notes_list parameters: - description: A UUID string identifying this rack group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_rack_groups_notes_create parameters: - description: A UUID string identifying this rack group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-reservations/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Rack group (slug) explode: true in: query name: group schema: items: format: uuid type: string type: array style: form - description: Rack group (slug) explode: true in: query name: group__n schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: group_id schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: group_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Rack (name or ID) explode: true in: query name: rack schema: items: format: uuid type: string type: array style: form - description: Rack (name or ID) explode: true in: query name: rack__n schema: items: format: uuid type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id schema: items: format: uuid type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: User (name) explode: true in: query name: user schema: items: type: string type: array style: form - description: User (name) explode: true in: query name: user__n schema: items: type: string type: array style: form - description: User (ID) explode: true in: query name: user_id schema: items: format: uuid type: string type: array style: form - description: User (ID) explode: true in: query name: user_id__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRackReservationList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRackReservationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RackReservation' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackReservationRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackReservation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRackReservationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RackReservation' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-reservations/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_destroy parameters: - description: A UUID string identifying this rack reservation. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_retrieve parameters: - description: A UUID string identifying this rack reservation. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackReservation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_partial_update parameters: - description: A UUID string identifying this rack reservation. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRackReservationRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackReservation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_reservations_update parameters: - description: A UUID string identifying this rack reservation. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackReservationRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackReservation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-reservations/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_rack_reservations_notes_list parameters: - description: A UUID string identifying this rack reservation. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_rack_reservations_notes_create parameters: - description: A UUID string identifying this rack reservation. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-roles/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_list parameters: - explode: true in: query name: color schema: items: type: string type: array style: form - explode: true in: query name: color__ic schema: items: type: string type: array style: form - explode: true in: query name: color__ie schema: items: type: string type: array style: form - explode: true in: query name: color__iew schema: items: type: string type: array style: form - explode: true in: query name: color__ire schema: items: type: string type: array style: form - explode: true in: query name: color__isw schema: items: type: string type: array style: form - explode: true in: query name: color__n schema: items: type: string type: array style: form - explode: true in: query name: color__nic schema: items: type: string type: array style: form - explode: true in: query name: color__nie schema: items: type: string type: array style: form - explode: true in: query name: color__niew schema: items: type: string type: array style: form - explode: true in: query name: color__nire schema: items: type: string type: array style: form - explode: true in: query name: color__nisw schema: items: type: string type: array style: form - explode: true in: query name: color__nre schema: items: type: string type: array style: form - explode: true in: query name: color__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Has racks in: query name: has_racks schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: racks schema: items: format: uuid type: string type: array style: form - explode: true in: query name: racks__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRackRoleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRackRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RackRole' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_create requestBody: content: application/json: schema: $ref: '#/components/schemas/RackRoleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRackRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RackRole' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-roles/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_destroy parameters: - description: A UUID string identifying this rack role. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_retrieve parameters: - description: A UUID string identifying this rack role. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_partial_update parameters: - description: A UUID string identifying this rack role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRackRoleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rack_roles_update parameters: - description: A UUID string identifying this rack role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RackRoleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RackRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rack-roles/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_rack_roles_notes_list parameters: - description: A UUID string identifying this rack role. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_rack_roles_notes_create parameters: - description: A UUID string identifying this rack role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/racks/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_list parameters: - explode: true in: query name: asset_tag schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ic schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ie schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__iew schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ire schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__isw schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__n schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nic schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nie schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__niew schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nire schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nisw schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nre schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__re schema: items: type: string type: array style: form - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: desc_units schema: type: boolean - explode: true in: query name: devices schema: items: format: uuid type: string type: array style: form - explode: true in: query name: devices__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: facility_id schema: items: type: string type: array style: form - explode: true in: query name: facility_id__ic schema: items: type: string type: array style: form - explode: true in: query name: facility_id__ie schema: items: type: string type: array style: form - explode: true in: query name: facility_id__iew schema: items: type: string type: array style: form - explode: true in: query name: facility_id__ire schema: items: type: string type: array style: form - explode: true in: query name: facility_id__isw schema: items: type: string type: array style: form - explode: true in: query name: facility_id__n schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nic schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nie schema: items: type: string type: array style: form - explode: true in: query name: facility_id__niew schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nire schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nisw schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nre schema: items: type: string type: array style: form - explode: true in: query name: facility_id__re schema: items: type: string type: array style: form - description: Rack group (slug) explode: true in: query name: group schema: items: format: uuid type: string type: array style: form - description: Rack group (slug) explode: true in: query name: group__n schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: group_id schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: group_id__n schema: items: format: uuid type: string type: array style: form - description: Has devices in: query name: has_devices schema: type: boolean - description: Has power feeds in: query name: has_power_feeds schema: type: boolean - description: Has reservations in: query name: has_reservations schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: outer_depth schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__gt schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__gte schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__lt schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__lte schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__n schema: items: type: integer type: array style: form - in: query name: outer_unit schema: type: string - in: query name: outer_unit__n schema: type: string - explode: true in: query name: outer_width schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__gt schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__gte schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__lt schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__lte schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__n schema: items: type: integer type: array style: form - description: Power feeds (name or ID) explode: true in: query name: power_feeds schema: items: format: uuid type: string type: array style: form - description: Power feeds (name or ID) explode: true in: query name: power_feeds__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: reservations schema: items: format: uuid type: string type: array style: form - explode: true in: query name: reservations__n schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (slug) explode: true in: query name: role__n schema: items: type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id__n schema: items: format: uuid nullable: true type: string type: array style: form - in: query name: serial schema: type: string - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: type schema: items: type: string type: array style: form - explode: true in: query name: type__n schema: items: type: string type: array style: form - explode: true in: query name: u_height schema: items: type: integer type: array style: form - explode: true in: query name: u_height__gt schema: items: type: integer type: array style: form - explode: true in: query name: u_height__gte schema: items: type: integer type: array style: form - explode: true in: query name: u_height__lt schema: items: type: integer type: array style: form - explode: true in: query name: u_height__lte schema: items: type: integer type: array style: form - explode: true in: query name: u_height__n schema: items: type: integer type: array style: form - description: Rail-to-rail width explode: true in: query name: width schema: items: type: integer type: array style: form - description: Rail-to-rail width explode: true in: query name: width__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRackList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRackRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Rack' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Rack' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRackRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Rack' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/racks/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_destroy parameters: - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_retrieve parameters: - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Rack' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_partial_update parameters: - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRackRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Rack' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_racks_update parameters: - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRackRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Rack' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/racks/{id}/elevation/: get: description: Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG. operationId: dcim_racks_elevation_list parameters: - explode: true in: query name: asset_tag schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ic schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ie schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__iew schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__ire schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__isw schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__n schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nic schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nie schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__niew schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nire schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nisw schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__nre schema: items: type: string type: array style: form - explode: true in: query name: asset_tag__re schema: items: type: string type: array style: form - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: desc_units schema: type: boolean - explode: true in: query name: devices schema: items: format: uuid type: string type: array style: form - explode: true in: query name: devices__n schema: items: format: uuid type: string type: array style: form - in: query name: display_fullname schema: default: true type: boolean - in: query name: exclude schema: format: uuid type: string - in: query name: expand_devices schema: default: true type: boolean - in: query name: face schema: default: front enum: - front - rear minLength: 1 type: string - explode: true in: query name: facility_id schema: items: type: string type: array style: form - explode: true in: query name: facility_id__ic schema: items: type: string type: array style: form - explode: true in: query name: facility_id__ie schema: items: type: string type: array style: form - explode: true in: query name: facility_id__iew schema: items: type: string type: array style: form - explode: true in: query name: facility_id__ire schema: items: type: string type: array style: form - explode: true in: query name: facility_id__isw schema: items: type: string type: array style: form - explode: true in: query name: facility_id__n schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nic schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nie schema: items: type: string type: array style: form - explode: true in: query name: facility_id__niew schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nire schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nisw schema: items: type: string type: array style: form - explode: true in: query name: facility_id__nre schema: items: type: string type: array style: form - explode: true in: query name: facility_id__re schema: items: type: string type: array style: form - description: Rack group (slug) explode: true in: query name: group schema: items: format: uuid type: string type: array style: form - description: Rack group (slug) explode: true in: query name: group__n schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: group_id schema: items: format: uuid type: string type: array style: form - description: Rack group (ID) explode: true in: query name: group_id__n schema: items: format: uuid type: string type: array style: form - description: Has devices in: query name: has_devices schema: type: boolean - description: Has power feeds in: query name: has_power_feeds schema: type: boolean - description: Has reservations in: query name: has_reservations schema: type: boolean - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: include_images schema: default: true type: boolean - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - in: query name: legend_width schema: default: 30 type: integer - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: outer_depth schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__gt schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__gte schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__lt schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__lte schema: items: type: integer type: array style: form - explode: true in: query name: outer_depth__n schema: items: type: integer type: array style: form - in: query name: outer_unit schema: type: string - in: query name: outer_unit__n schema: type: string - explode: true in: query name: outer_width schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__gt schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__gte schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__lt schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__lte schema: items: type: integer type: array style: form - explode: true in: query name: outer_width__n schema: items: type: integer type: array style: form - description: Power feeds (name or ID) explode: true in: query name: power_feeds schema: items: format: uuid type: string type: array style: form - description: Power feeds (name or ID) explode: true in: query name: power_feeds__n schema: items: format: uuid type: string type: array style: form - in: query name: q schema: minLength: 1 type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - in: query name: render schema: default: json enum: - json - svg minLength: 1 type: string - explode: true in: query name: reservations schema: items: format: uuid type: string type: array style: form - explode: true in: query name: reservations__n schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (slug) explode: true in: query name: role__n schema: items: type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id__n schema: items: format: uuid nullable: true type: string type: array style: form - in: query name: serial schema: type: string - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: type schema: items: type: string type: array style: form - explode: true in: query name: type__n schema: items: type: string type: array style: form - explode: true in: query name: u_height schema: items: type: integer type: array style: form - explode: true in: query name: u_height__gt schema: items: type: integer type: array style: form - explode: true in: query name: u_height__gte schema: items: type: integer type: array style: form - explode: true in: query name: u_height__lt schema: items: type: integer type: array style: form - explode: true in: query name: u_height__lte schema: items: type: integer type: array style: form - explode: true in: query name: u_height__n schema: items: type: integer type: array style: form - in: query name: unit_height schema: type: integer - in: query name: unit_width schema: type: integer - description: Rail-to-rail width explode: true in: query name: width schema: items: type: integer type: array style: form - description: Rail-to-rail width explode: true in: query name: width__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRackUnitList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/racks/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_racks_notes_list parameters: - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_racks_notes_create parameters: - description: A UUID string identifying this rack. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-port-templates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_list parameters: - description: Description explode: true in: query name: description schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__iew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__ire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__isw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__n schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nic schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nie schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__niew schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nire schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nisw schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__nre schema: items: type: string type: array style: form - description: Description explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type schema: items: format: uuid type: string type: array style: form - description: Device type (slug or ID) explode: true in: query name: device_type__n schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id schema: items: format: uuid type: string type: array style: form - description: Device type (ID) explode: true in: query name: devicetype_id__n schema: items: format: uuid type: string type: array style: form - description: Front port templates explode: true in: query name: front_port_templates schema: items: format: uuid type: string type: array style: form - description: Front port templates explode: true in: query name: front_port_templates__n schema: items: format: uuid type: string type: array style: form - description: Has front port templates in: query name: has_front_port_templates schema: type: boolean - description: ID explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - description: ID explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Label explode: true in: query name: label schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__iew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__ire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__isw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__n schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nic schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nie schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__niew schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nire schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nisw schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__nre schema: items: type: string type: array style: form - description: Label explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Name explode: true in: query name: name schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__iew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__ire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__isw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__n schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nic schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nie schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__niew schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nire schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nisw schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__nre schema: items: type: string type: array style: form - description: Name explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: positions schema: items: type: integer type: array style: form - explode: true in: query name: positions__gt schema: items: type: integer type: array style: form - explode: true in: query name: positions__gte schema: items: type: integer type: array style: form - explode: true in: query name: positions__lt schema: items: type: integer type: array style: form - explode: true in: query name: positions__lte schema: items: type: integer type: array style: form - explode: true in: query name: positions__n schema: items: type: integer type: array style: form - description: Search in: query name: q schema: type: string - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRearPortTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRearPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RearPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRearPortTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRearPortTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RearPortTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-port-templates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_destroy parameters: - description: A UUID string identifying this rear port template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_retrieve parameters: - description: A UUID string identifying this rear port template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_partial_update parameters: - description: A UUID string identifying this rear port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRearPortTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_port_templates_update parameters: - description: A UUID string identifying this rear port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRearPortTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPortTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-port-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_rear_port_templates_notes_list parameters: - description: A UUID string identifying this rear port template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_rear_port_templates_notes_create parameters: - description: A UUID string identifying this rear port template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-ports/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_list parameters: - description: Cable explode: true in: query name: cable schema: items: format: uuid type: string type: array style: form - description: Cable explode: true in: query name: cable__n schema: items: format: uuid type: string type: array style: form - in: query name: cabled schema: type: boolean - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - description: Front ports (name or ID) explode: true in: query name: front_ports schema: items: format: uuid type: string type: array style: form - description: Front ports (name or ID) explode: true in: query name: front_ports__n schema: items: format: uuid type: string type: array style: form - description: Has front ports in: query name: has_front_ports schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: label schema: items: type: string type: array style: form - explode: true in: query name: label__ic schema: items: type: string type: array style: form - explode: true in: query name: label__ie schema: items: type: string type: array style: form - explode: true in: query name: label__iew schema: items: type: string type: array style: form - explode: true in: query name: label__ire schema: items: type: string type: array style: form - explode: true in: query name: label__isw schema: items: type: string type: array style: form - explode: true in: query name: label__n schema: items: type: string type: array style: form - explode: true in: query name: label__nic schema: items: type: string type: array style: form - explode: true in: query name: label__nie schema: items: type: string type: array style: form - explode: true in: query name: label__niew schema: items: type: string type: array style: form - explode: true in: query name: label__nire schema: items: type: string type: array style: form - explode: true in: query name: label__nisw schema: items: type: string type: array style: form - explode: true in: query name: label__nre schema: items: type: string type: array style: form - explode: true in: query name: label__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: positions schema: items: type: integer type: array style: form - explode: true in: query name: positions__gt schema: items: type: integer type: array style: form - explode: true in: query name: positions__gte schema: items: type: integer type: array style: form - explode: true in: query name: positions__lt schema: items: type: integer type: array style: form - explode: true in: query name: positions__lte schema: items: type: integer type: array style: form - explode: true in: query name: positions__n schema: items: type: integer type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - in: query name: type schema: type: string - in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRearPortList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRearPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RearPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRearPortRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRearPortRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RearPort' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-ports/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_destroy parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_retrieve parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_partial_update parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRearPortRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_rear_ports_update parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRearPortRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-ports/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_rear_ports_notes_list parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_rear_ports_notes_create parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/rear-ports/{id}/paths/: get: description: Return all CablePaths which traverse a given pass-through port. operationId: dcim_rear_ports_paths_retrieve parameters: - description: A UUID string identifying this rear port. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RearPort' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/regions/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_list parameters: - description: Children (slug or ID) explode: true in: query name: children schema: items: format: uuid type: string type: array style: form - description: Children (slug or ID) explode: true in: query name: children__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Has children in: query name: has_children schema: type: boolean - description: Has sites in: query name: has_sites schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent region (slug) explode: true in: query name: parent schema: items: type: string type: array style: form - description: Parent region (slug) explode: true in: query name: parent__n schema: items: type: string type: array style: form - description: Parent region (ID) explode: true in: query name: parent_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Parent region (ID) explode: true in: query name: parent_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Sites (slug or ID) explode: true in: query name: sites schema: items: format: uuid type: string type: array style: form - description: Sites (slug or ID) explode: true in: query name: sites__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRegionList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRegionRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Region' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRegionRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Region' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRegionRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Region' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/regions/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_destroy parameters: - description: A UUID string identifying this region. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_retrieve parameters: - description: A UUID string identifying this region. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Region' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_partial_update parameters: - description: A UUID string identifying this region. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRegionRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Region' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_regions_update parameters: - description: A UUID string identifying this region. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRegionRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Region' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/regions/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_regions_notes_list parameters: - description: A UUID string identifying this region. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_regions_notes_create parameters: - description: A UUID string identifying this region. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/sites/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_list parameters: - explode: true in: query name: asn schema: items: type: integer type: array style: form - explode: true in: query name: asn__gt schema: items: type: integer type: array style: form - explode: true in: query name: asn__gte schema: items: type: integer type: array style: form - explode: true in: query name: asn__lt schema: items: type: integer type: array style: form - explode: true in: query name: asn__lte schema: items: type: integer type: array style: form - explode: true in: query name: asn__n schema: items: type: integer type: array style: form - explode: true in: query name: circuit_terminations schema: items: format: uuid type: string type: array style: form - explode: true in: query name: circuit_terminations__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: clusters schema: items: format: uuid type: string type: array style: form - explode: true in: query name: clusters__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - explode: true in: query name: contact_email schema: items: type: string type: array style: form - explode: true in: query name: contact_email__ic schema: items: type: string type: array style: form - explode: true in: query name: contact_email__ie schema: items: type: string type: array style: form - explode: true in: query name: contact_email__iew schema: items: type: string type: array style: form - explode: true in: query name: contact_email__ire schema: items: type: string type: array style: form - explode: true in: query name: contact_email__isw schema: items: type: string type: array style: form - explode: true in: query name: contact_email__n schema: items: type: string type: array style: form - explode: true in: query name: contact_email__nic schema: items: type: string type: array style: form - explode: true in: query name: contact_email__nie schema: items: type: string type: array style: form - explode: true in: query name: contact_email__niew schema: items: type: string type: array style: form - explode: true in: query name: contact_email__nire schema: items: type: string type: array style: form - explode: true in: query name: contact_email__nisw schema: items: type: string type: array style: form - explode: true in: query name: contact_email__nre schema: items: type: string type: array style: form - explode: true in: query name: contact_email__re schema: items: type: string type: array style: form - explode: true in: query name: contact_name schema: items: type: string type: array style: form - explode: true in: query name: contact_name__ic schema: items: type: string type: array style: form - explode: true in: query name: contact_name__ie schema: items: type: string type: array style: form - explode: true in: query name: contact_name__iew schema: items: type: string type: array style: form - explode: true in: query name: contact_name__ire schema: items: type: string type: array style: form - explode: true in: query name: contact_name__isw schema: items: type: string type: array style: form - explode: true in: query name: contact_name__n schema: items: type: string type: array style: form - explode: true in: query name: contact_name__nic schema: items: type: string type: array style: form - explode: true in: query name: contact_name__nie schema: items: type: string type: array style: form - explode: true in: query name: contact_name__niew schema: items: type: string type: array style: form - explode: true in: query name: contact_name__nire schema: items: type: string type: array style: form - explode: true in: query name: contact_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: contact_name__nre schema: items: type: string type: array style: form - explode: true in: query name: contact_name__re schema: items: type: string type: array style: form - explode: true in: query name: contact_phone schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__ic schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__ie schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__iew schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__ire schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__isw schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__n schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__nic schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__nie schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__niew schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__nire schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__nisw schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__nre schema: items: type: string type: array style: form - explode: true in: query name: contact_phone__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Devices (name or ID) explode: true in: query name: devices schema: items: format: uuid type: string type: array style: form - description: Devices (name or ID) explode: true in: query name: devices__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: facility schema: items: type: string type: array style: form - explode: true in: query name: facility__ic schema: items: type: string type: array style: form - explode: true in: query name: facility__ie schema: items: type: string type: array style: form - explode: true in: query name: facility__iew schema: items: type: string type: array style: form - explode: true in: query name: facility__ire schema: items: type: string type: array style: form - explode: true in: query name: facility__isw schema: items: type: string type: array style: form - explode: true in: query name: facility__n schema: items: type: string type: array style: form - explode: true in: query name: facility__nic schema: items: type: string type: array style: form - explode: true in: query name: facility__nie schema: items: type: string type: array style: form - explode: true in: query name: facility__niew schema: items: type: string type: array style: form - explode: true in: query name: facility__nire schema: items: type: string type: array style: form - explode: true in: query name: facility__nisw schema: items: type: string type: array style: form - explode: true in: query name: facility__nre schema: items: type: string type: array style: form - explode: true in: query name: facility__re schema: items: type: string type: array style: form - description: Has circuit terminations in: query name: has_circuit_terminations schema: type: boolean - description: Has clusters in: query name: has_clusters schema: type: boolean - description: Has devices in: query name: has_devices schema: type: boolean - description: Has locations in: query name: has_locations schema: type: boolean - description: Has power panels in: query name: has_power_panels schema: type: boolean - description: Has prefixes in: query name: has_prefixes schema: type: boolean - description: Has rack groups in: query name: has_rack_groups schema: type: boolean - description: Has racks in: query name: has_racks schema: type: boolean - description: Has vlan groups in: query name: has_vlan_groups schema: type: boolean - description: Has vlans in: query name: has_vlans schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - explode: true in: query name: latitude schema: items: type: number type: array style: form - explode: true in: query name: latitude__gt schema: items: type: number type: array style: form - explode: true in: query name: latitude__gte schema: items: type: number type: array style: form - explode: true in: query name: latitude__lt schema: items: type: number type: array style: form - explode: true in: query name: latitude__lte schema: items: type: number type: array style: form - explode: true in: query name: latitude__n schema: items: type: number type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Locations within this Site (slugs or IDs) explode: true in: query name: locations schema: items: format: uuid type: string type: array style: form - description: Locations within this Site (slugs or IDs) explode: true in: query name: locations__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: longitude schema: items: type: number type: array style: form - explode: true in: query name: longitude__gt schema: items: type: number type: array style: form - explode: true in: query name: longitude__gte schema: items: type: number type: array style: form - explode: true in: query name: longitude__lt schema: items: type: number type: array style: form - explode: true in: query name: longitude__lte schema: items: type: number type: array style: form - explode: true in: query name: longitude__n schema: items: type: number type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: physical_address schema: items: type: string type: array style: form - explode: true in: query name: physical_address__ic schema: items: type: string type: array style: form - explode: true in: query name: physical_address__ie schema: items: type: string type: array style: form - explode: true in: query name: physical_address__iew schema: items: type: string type: array style: form - explode: true in: query name: physical_address__ire schema: items: type: string type: array style: form - explode: true in: query name: physical_address__isw schema: items: type: string type: array style: form - explode: true in: query name: physical_address__n schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nic schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nie schema: items: type: string type: array style: form - explode: true in: query name: physical_address__niew schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nire schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nisw schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nre schema: items: type: string type: array style: form - explode: true in: query name: physical_address__re schema: items: type: string type: array style: form - description: Power panels (name or ID) explode: true in: query name: power_panels schema: items: format: uuid type: string type: array style: form - description: Power panels (name or ID) explode: true in: query name: power_panels__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: prefixes schema: items: format: uuid type: string type: array style: form - explode: true in: query name: prefixes__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Rack groups (slug or ID) explode: true in: query name: rack_groups schema: items: format: uuid type: string type: array style: form - description: Rack groups (slug or ID) explode: true in: query name: rack_groups__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: racks schema: items: format: uuid type: string type: array style: form - explode: true in: query name: racks__n schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: shipping_address schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__ic schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__ie schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__iew schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__ire schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__isw schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__n schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__nic schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__nie schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__niew schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__nire schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__nisw schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__nre schema: items: type: string type: array style: form - explode: true in: query name: shipping_address__re schema: items: type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Time zone explode: true in: query name: time_zone schema: items: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: array style: form - description: Time zone explode: true in: query name: time_zone__n schema: items: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: array style: form - description: Vlan groups (slug or ID) explode: true in: query name: vlan_groups schema: items: format: uuid type: string type: array style: form - description: Vlan groups (slug or ID) explode: true in: query name: vlan_groups__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: vlans schema: items: format: uuid type: string type: array style: form - explode: true in: query name: vlans__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedSiteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableSiteRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Site' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSiteRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Site' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableSiteRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Site' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/sites/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_destroy parameters: - description: A UUID string identifying this site. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_retrieve parameters: - description: A UUID string identifying this site. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Site' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_partial_update parameters: - description: A UUID string identifying this site. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableSiteRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Site' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: dcim_sites_update parameters: - description: A UUID string identifying this site. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSiteRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Site' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/sites/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_sites_notes_list parameters: - description: A UUID string identifying this site. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_sites_notes_create parameters: - description: A UUID string identifying this site. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/virtual-chassis/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: domain schema: items: type: string type: array style: form - explode: true in: query name: domain__ic schema: items: type: string type: array style: form - explode: true in: query name: domain__ie schema: items: type: string type: array style: form - explode: true in: query name: domain__iew schema: items: type: string type: array style: form - explode: true in: query name: domain__ire schema: items: type: string type: array style: form - explode: true in: query name: domain__isw schema: items: type: string type: array style: form - explode: true in: query name: domain__n schema: items: type: string type: array style: form - explode: true in: query name: domain__nic schema: items: type: string type: array style: form - explode: true in: query name: domain__nie schema: items: type: string type: array style: form - explode: true in: query name: domain__niew schema: items: type: string type: array style: form - explode: true in: query name: domain__nire schema: items: type: string type: array style: form - explode: true in: query name: domain__nisw schema: items: type: string type: array style: form - explode: true in: query name: domain__nre schema: items: type: string type: array style: form - explode: true in: query name: domain__re schema: items: type: string type: array style: form - description: Has device members in: query name: has_members schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Master (name) explode: true in: query name: master schema: items: nullable: true type: string type: array style: form - description: Master (name) explode: true in: query name: master__n schema: items: nullable: true type: string type: array style: form - description: Master (ID) explode: true in: query name: master_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Master (ID) explode: true in: query name: master_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Device members (name or ID) explode: true in: query name: members schema: items: format: uuid type: string type: array style: form - description: Device members (name or ID) explode: true in: query name: members__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site name (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug) explode: true in: query name: tenant schema: items: type: string type: array style: form - description: Tenant (slug) explode: true in: query name: tenant__n schema: items: type: string type: array style: form - description: Tenant (ID) explode: true in: query name: tenant_id schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) explode: true in: query name: tenant_id__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVirtualChassisList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVirtualChassisRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VirtualChassis' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualChassisRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualChassis' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVirtualChassisRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VirtualChassis' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/virtual-chassis/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_destroy parameters: - description: A UUID string identifying this virtual chassis. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - dcim get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_retrieve parameters: - description: A UUID string identifying this virtual chassis. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualChassis' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_partial_update parameters: - description: A UUID string identifying this virtual chassis. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualChassisRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualChassis' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: dcim_virtual_chassis_update parameters: - description: A UUID string identifying this virtual chassis. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualChassisRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualChassis' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /dcim/virtual-chassis/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: dcim_virtual_chassis_notes_list parameters: - description: A UUID string identifying this virtual chassis. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim post: description: API methods for returning or creating notes on an object. operationId: dcim_virtual_chassis_notes_create parameters: - description: A UUID string identifying this virtual chassis. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - dcim /extras/computed-fields/: delete: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_list parameters: - in: query name: content_type schema: type: string - in: query name: content_type__n schema: type: string - explode: true in: query name: fallback_value schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__ic schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__ie schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__iew schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__ire schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__isw schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__n schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__nic schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__nie schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__niew schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__nire schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__nisw schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__nre schema: items: type: string type: array style: form - explode: true in: query name: fallback_value__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: template schema: items: type: string type: array style: form - explode: true in: query name: template__ic schema: items: type: string type: array style: form - explode: true in: query name: template__ie schema: items: type: string type: array style: form - explode: true in: query name: template__iew schema: items: type: string type: array style: form - explode: true in: query name: template__ire schema: items: type: string type: array style: form - explode: true in: query name: template__isw schema: items: type: string type: array style: form - explode: true in: query name: template__n schema: items: type: string type: array style: form - explode: true in: query name: template__nic schema: items: type: string type: array style: form - explode: true in: query name: template__nie schema: items: type: string type: array style: form - explode: true in: query name: template__niew schema: items: type: string type: array style: form - explode: true in: query name: template__nire schema: items: type: string type: array style: form - explode: true in: query name: template__nisw schema: items: type: string type: array style: form - explode: true in: query name: template__nre schema: items: type: string type: array style: form - explode: true in: query name: template__re schema: items: type: string type: array style: form - explode: true in: query name: weight schema: items: type: integer type: array style: form - explode: true in: query name: weight__gt schema: items: type: integer type: array style: form - explode: true in: query name: weight__gte schema: items: type: integer type: array style: form - explode: true in: query name: weight__lt schema: items: type: integer type: array style: form - explode: true in: query name: weight__lte schema: items: type: integer type: array style: form - explode: true in: query name: weight__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedComputedFieldList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableComputedFieldRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ComputedField' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ComputedFieldRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComputedField' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableComputedFieldRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ComputedField' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/computed-fields/{id}/: delete: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_destroy parameters: - description: A UUID string identifying this computed field. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_retrieve parameters: - description: A UUID string identifying this computed field. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComputedField' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_partial_update parameters: - description: A UUID string identifying this computed field. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedComputedFieldRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComputedField' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Computed Fields through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_computed_fields_update parameters: - description: A UUID string identifying this computed field. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ComputedFieldRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComputedField' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/computed-fields/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_computed_fields_notes_list parameters: - description: A UUID string identifying this computed field. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_computed_fields_notes_create parameters: - description: A UUID string identifying this computed field. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/config-context-schemas/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_list parameters: - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: owner_content_type schema: type: string - in: query name: owner_content_type__n schema: type: string - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConfigContextSchemaList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConfigContextSchemaRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigContextSchema' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigContextSchemaRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContextSchema' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConfigContextSchemaRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigContextSchema' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/config-context-schemas/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_destroy parameters: - description: A UUID string identifying this config context schema. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_retrieve parameters: - description: A UUID string identifying this config context schema. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContextSchema' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_partial_update parameters: - description: A UUID string identifying this config context schema. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedConfigContextSchemaRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContextSchema' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_context_schemas_update parameters: - description: A UUID string identifying this config context schema. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigContextSchemaRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContextSchema' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/config-context-schemas/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_config_context_schemas_notes_list parameters: - description: A UUID string identifying this config context schema. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_config_context_schemas_notes_create parameters: - description: A UUID string identifying this config context schema. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/config-contexts/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_list parameters: - description: Cluster group (slug) explode: true in: query name: cluster_group schema: items: type: string type: array style: form - description: Cluster group (slug) explode: true in: query name: cluster_group__n schema: items: type: string type: array style: form - description: Cluster group explode: true in: query name: cluster_group_id schema: items: format: uuid type: string type: array style: form - description: Cluster group explode: true in: query name: cluster_group_id__n schema: items: format: uuid type: string type: array style: form - description: Cluster explode: true in: query name: cluster_id schema: items: format: uuid type: string type: array style: form - description: Cluster explode: true in: query name: cluster_id__n schema: items: format: uuid type: string type: array style: form - description: Device Redundancy Group (slug or PK) explode: true in: query name: device_redundancy_group schema: items: format: uuid type: string type: array style: form - description: Device Redundancy Group (slug or PK) explode: true in: query name: device_redundancy_group__n schema: items: format: uuid type: string type: array style: form - description: Device Type (slug) explode: true in: query name: device_type schema: items: type: string type: array style: form - description: Device Type (slug) explode: true in: query name: device_type__n schema: items: type: string type: array style: form - description: Device Type explode: true in: query name: device_type_id schema: items: format: uuid type: string type: array style: form - description: Device Type explode: true in: query name: device_type_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: is_active schema: type: boolean - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug) explode: true in: query name: location schema: items: type: string type: array style: form - description: Location (slug) explode: true in: query name: location__n schema: items: type: string type: array style: form - description: Location (ID) explode: true in: query name: location_id schema: items: format: uuid type: string type: array style: form - description: Location (ID) explode: true in: query name: location_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: owner_content_type schema: type: string - in: query name: owner_content_type__n schema: type: string - explode: true in: query name: owner_object_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__re schema: items: format: uuid type: string type: array style: form - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Platform (slug) explode: true in: query name: platform__n schema: items: type: string type: array style: form - description: Platform explode: true in: query name: platform_id schema: items: format: uuid type: string type: array style: form - description: Platform explode: true in: query name: platform_id__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Region (slug) explode: true in: query name: region schema: items: type: string type: array style: form - description: Region (slug) explode: true in: query name: region__n schema: items: type: string type: array style: form - description: Region explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (slug) explode: true in: query name: role__n schema: items: type: string type: array style: form - description: Role explode: true in: query name: role_id schema: items: format: uuid type: string type: array style: form - description: Role explode: true in: query name: role_id__n schema: items: format: uuid type: string type: array style: form - description: Schema (slug or PK) explode: true in: query name: schema schema: items: format: uuid type: string type: array style: form - description: Schema (slug or PK) explode: true in: query name: schema__n schema: items: format: uuid type: string type: array style: form - description: Site (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (slug) explode: true in: query name: site__n schema: items: type: string type: array style: form - description: Site explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Site explode: true in: query name: site_id__n schema: items: format: uuid type: string type: array style: form - description: Tag (slug) explode: true in: query name: tag schema: items: type: string type: array style: form - description: Tag (slug) explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug) explode: true in: query name: tenant schema: items: type: string type: array style: form - description: Tenant (slug) explode: true in: query name: tenant__n schema: items: type: string type: array style: form - description: Tenant group (slug) explode: true in: query name: tenant_group schema: items: type: string type: array style: form - description: Tenant group (slug) explode: true in: query name: tenant_group__n schema: items: type: string type: array style: form - description: Tenant group explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant group explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant explode: true in: query name: tenant_id schema: items: format: uuid type: string type: array style: form - description: Tenant explode: true in: query name: tenant_id__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConfigContextList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConfigContextRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigContext' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConfigContextRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConfigContextRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigContext' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/config-contexts/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_destroy parameters: - description: A UUID string identifying this config context. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_retrieve parameters: - description: A UUID string identifying this config context. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_partial_update parameters: - description: A UUID string identifying this config context. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableConfigContextRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_config_contexts_update parameters: - description: A UUID string identifying this config context. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableConfigContextRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/config-contexts/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_config_contexts_notes_list parameters: - description: A UUID string identifying this config context. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_config_contexts_notes_create parameters: - description: A UUID string identifying this config context. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/content-types/: get: description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to Nautobot objects. operationId: extras_content_types_list parameters: - explode: true in: query name: app_label schema: items: type: string type: array style: form - explode: true in: query name: app_label__ic schema: items: type: string type: array style: form - explode: true in: query name: app_label__ie schema: items: type: string type: array style: form - explode: true in: query name: app_label__iew schema: items: type: string type: array style: form - explode: true in: query name: app_label__ire schema: items: type: string type: array style: form - explode: true in: query name: app_label__isw schema: items: type: string type: array style: form - explode: true in: query name: app_label__n schema: items: type: string type: array style: form - explode: true in: query name: app_label__nic schema: items: type: string type: array style: form - explode: true in: query name: app_label__nie schema: items: type: string type: array style: form - explode: true in: query name: app_label__niew schema: items: type: string type: array style: form - explode: true in: query name: app_label__nire schema: items: type: string type: array style: form - explode: true in: query name: app_label__nisw schema: items: type: string type: array style: form - explode: true in: query name: app_label__nre schema: items: type: string type: array style: form - explode: true in: query name: app_label__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: type: integer type: array style: form - explode: true in: query name: id__gt schema: items: type: integer type: array style: form - explode: true in: query name: id__gte schema: items: type: integer type: array style: form - explode: true in: query name: id__lt schema: items: type: integer type: array style: form - explode: true in: query name: id__lte schema: items: type: integer type: array style: form - explode: true in: query name: id__n schema: items: type: integer type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: model schema: items: type: string type: array style: form - explode: true in: query name: model__ic schema: items: type: string type: array style: form - explode: true in: query name: model__ie schema: items: type: string type: array style: form - explode: true in: query name: model__iew schema: items: type: string type: array style: form - explode: true in: query name: model__ire schema: items: type: string type: array style: form - explode: true in: query name: model__isw schema: items: type: string type: array style: form - explode: true in: query name: model__n schema: items: type: string type: array style: form - explode: true in: query name: model__nic schema: items: type: string type: array style: form - explode: true in: query name: model__nie schema: items: type: string type: array style: form - explode: true in: query name: model__niew schema: items: type: string type: array style: form - explode: true in: query name: model__nire schema: items: type: string type: array style: form - explode: true in: query name: model__nisw schema: items: type: string type: array style: form - explode: true in: query name: model__nre schema: items: type: string type: array style: form - explode: true in: query name: model__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedContentTypeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/content-types/{id}/: get: description: Read-only list of ContentTypes. Limit results to ContentTypes pertinent to Nautobot objects. operationId: extras_content_types_retrieve parameters: - description: A unique integer value identifying this content type. in: path name: id required: true schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContentType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-field-choices/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_list parameters: - description: Field (name) explode: true in: query name: field schema: items: type: string type: array style: form - description: Field (name) explode: true in: query name: field__n schema: items: type: string type: array style: form - description: Field explode: true in: query name: field_id schema: items: format: uuid type: string type: array style: form - description: Field explode: true in: query name: field_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: value schema: items: type: string type: array style: form - explode: true in: query name: value__ic schema: items: type: string type: array style: form - explode: true in: query name: value__ie schema: items: type: string type: array style: form - explode: true in: query name: value__iew schema: items: type: string type: array style: form - explode: true in: query name: value__ire schema: items: type: string type: array style: form - explode: true in: query name: value__isw schema: items: type: string type: array style: form - explode: true in: query name: value__n schema: items: type: string type: array style: form - explode: true in: query name: value__nic schema: items: type: string type: array style: form - explode: true in: query name: value__nie schema: items: type: string type: array style: form - explode: true in: query name: value__niew schema: items: type: string type: array style: form - explode: true in: query name: value__nire schema: items: type: string type: array style: form - explode: true in: query name: value__nisw schema: items: type: string type: array style: form - explode: true in: query name: value__nre schema: items: type: string type: array style: form - explode: true in: query name: value__re schema: items: type: string type: array style: form - explode: true in: query name: weight schema: items: type: integer type: array style: form - explode: true in: query name: weight__gt schema: items: type: integer type: array style: form - explode: true in: query name: weight__gte schema: items: type: integer type: array style: form - explode: true in: query name: weight__lt schema: items: type: integer type: array style: form - explode: true in: query name: weight__lte schema: items: type: integer type: array style: form - explode: true in: query name: weight__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCustomFieldChoiceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCustomFieldChoiceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CustomFieldChoice' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCustomFieldChoiceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldChoice' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCustomFieldChoiceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CustomFieldChoice' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-field-choices/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_destroy parameters: - description: A UUID string identifying this custom field choice. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_retrieve parameters: - description: A UUID string identifying this custom field choice. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldChoice' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_partial_update parameters: - description: A UUID string identifying this custom field choice. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCustomFieldChoiceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldChoice' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_field_choices_update parameters: - description: A UUID string identifying this custom field choice. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCustomFieldChoiceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldChoice' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-fields/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_list parameters: - explode: true in: query name: content_types schema: items: type: integer type: array style: form - explode: true in: query name: content_types__n schema: items: type: integer type: array style: form - description: Loose matches any instance of a given string; Exact matches the entire field. in: query name: filter_logic schema: type: string - description: Loose matches any instance of a given string; Exact matches the entire field. in: query name: filter_logic__n schema: type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: required schema: type: boolean - explode: true in: query name: weight schema: items: type: integer type: array style: form - explode: true in: query name: weight__gt schema: items: type: integer type: array style: form - explode: true in: query name: weight__gte schema: items: type: integer type: array style: form - explode: true in: query name: weight__lt schema: items: type: integer type: array style: form - explode: true in: query name: weight__lte schema: items: type: integer type: array style: form - explode: true in: query name: weight__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCustomFieldSerializerVersion12List' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/CustomFieldSerializerVersion12Request' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CustomFieldSerializerVersion12' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldSerializerVersion12Request' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/CustomFieldSerializerVersion12Request' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CustomFieldSerializerVersion12' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-fields/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_destroy parameters: - description: A UUID string identifying this custom field. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_retrieve parameters: - description: A UUID string identifying this custom field. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_partial_update parameters: - description: A UUID string identifying this custom field. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCustomFieldSerializerVersion12Request' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_custom_fields_update parameters: - description: A UUID string identifying this custom field. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomFieldSerializerVersion12Request' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomFieldSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-fields/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_custom_fields_notes_list parameters: - description: A UUID string identifying this custom field. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_custom_fields_notes_create parameters: - description: A UUID string identifying this custom field. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-links/: delete: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_list parameters: - description: The class of the first link in a group will be used for the dropdown button in: query name: button_class schema: type: string - description: The class of the first link in a group will be used for the dropdown button in: query name: button_class__n schema: type: string - in: query name: content_type schema: type: string - in: query name: content_type__n schema: type: string - explode: true in: query name: group_name schema: items: type: string type: array style: form - explode: true in: query name: group_name__ic schema: items: type: string type: array style: form - explode: true in: query name: group_name__ie schema: items: type: string type: array style: form - explode: true in: query name: group_name__iew schema: items: type: string type: array style: form - explode: true in: query name: group_name__ire schema: items: type: string type: array style: form - explode: true in: query name: group_name__isw schema: items: type: string type: array style: form - explode: true in: query name: group_name__n schema: items: type: string type: array style: form - explode: true in: query name: group_name__nic schema: items: type: string type: array style: form - explode: true in: query name: group_name__nie schema: items: type: string type: array style: form - explode: true in: query name: group_name__niew schema: items: type: string type: array style: form - explode: true in: query name: group_name__nire schema: items: type: string type: array style: form - explode: true in: query name: group_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: group_name__nre schema: items: type: string type: array style: form - explode: true in: query name: group_name__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - in: query name: new_window schema: type: boolean - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: target_url schema: items: type: string type: array style: form - explode: true in: query name: target_url__ic schema: items: type: string type: array style: form - explode: true in: query name: target_url__ie schema: items: type: string type: array style: form - explode: true in: query name: target_url__iew schema: items: type: string type: array style: form - explode: true in: query name: target_url__ire schema: items: type: string type: array style: form - explode: true in: query name: target_url__isw schema: items: type: string type: array style: form - explode: true in: query name: target_url__n schema: items: type: string type: array style: form - explode: true in: query name: target_url__nic schema: items: type: string type: array style: form - explode: true in: query name: target_url__nie schema: items: type: string type: array style: form - explode: true in: query name: target_url__niew schema: items: type: string type: array style: form - explode: true in: query name: target_url__nire schema: items: type: string type: array style: form - explode: true in: query name: target_url__nisw schema: items: type: string type: array style: form - explode: true in: query name: target_url__nre schema: items: type: string type: array style: form - explode: true in: query name: target_url__re schema: items: type: string type: array style: form - explode: true in: query name: text schema: items: type: string type: array style: form - explode: true in: query name: text__ic schema: items: type: string type: array style: form - explode: true in: query name: text__ie schema: items: type: string type: array style: form - explode: true in: query name: text__iew schema: items: type: string type: array style: form - explode: true in: query name: text__ire schema: items: type: string type: array style: form - explode: true in: query name: text__isw schema: items: type: string type: array style: form - explode: true in: query name: text__n schema: items: type: string type: array style: form - explode: true in: query name: text__nic schema: items: type: string type: array style: form - explode: true in: query name: text__nie schema: items: type: string type: array style: form - explode: true in: query name: text__niew schema: items: type: string type: array style: form - explode: true in: query name: text__nire schema: items: type: string type: array style: form - explode: true in: query name: text__nisw schema: items: type: string type: array style: form - explode: true in: query name: text__nre schema: items: type: string type: array style: form - explode: true in: query name: text__re schema: items: type: string type: array style: form - explode: true in: query name: weight schema: items: type: integer type: array style: form - explode: true in: query name: weight__gt schema: items: type: integer type: array style: form - explode: true in: query name: weight__gte schema: items: type: integer type: array style: form - explode: true in: query name: weight__lt schema: items: type: integer type: array style: form - explode: true in: query name: weight__lte schema: items: type: integer type: array style: form - explode: true in: query name: weight__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCustomLinkList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCustomLinkRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CustomLink' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomLinkRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomLink' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCustomLinkRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CustomLink' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-links/{id}/: delete: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_destroy parameters: - description: A UUID string identifying this custom link. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_retrieve parameters: - description: A UUID string identifying this custom link. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomLink' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_partial_update parameters: - description: A UUID string identifying this custom link. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCustomLinkRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomLink' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Custom Links through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_custom_links_update parameters: - description: A UUID string identifying this custom link. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomLinkRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CustomLink' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/custom-links/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_custom_links_notes_list parameters: - description: A UUID string identifying this custom link. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_custom_links_notes_create parameters: - description: A UUID string identifying this custom link. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/dynamic-group-memberships/: delete: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Group (slug or ID) explode: true in: query name: group schema: items: format: uuid type: string type: array style: form - description: Group (slug or ID) explode: true in: query name: group__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: operator schema: enum: - difference - intersection - union type: string - in: query name: operator__n schema: enum: - difference - intersection - union type: string - description: Parent Group (slug or ID) explode: true in: query name: parent_group schema: items: format: uuid type: string type: array style: form - description: Parent Group (slug or ID) explode: true in: query name: parent_group__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: weight schema: items: type: integer type: array style: form - explode: true in: query name: weight__gt schema: items: type: integer type: array style: form - explode: true in: query name: weight__gte schema: items: type: integer type: array style: form - explode: true in: query name: weight__lt schema: items: type: integer type: array style: form - explode: true in: query name: weight__lte schema: items: type: integer type: array style: form - explode: true in: query name: weight__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDynamicGroupMembershipList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDynamicGroupMembershipRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DynamicGroupMembership' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDynamicGroupMembershipRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroupMembership' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDynamicGroupMembershipRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DynamicGroupMembership' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/dynamic-group-memberships/{id}/: delete: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_destroy parameters: - description: A UUID string identifying this dynamic group membership. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_retrieve parameters: - description: A UUID string identifying this dynamic group membership. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroupMembership' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_partial_update parameters: - description: A UUID string identifying this dynamic group membership. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableDynamicGroupMembershipRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroupMembership' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Dynamic Group Memberships through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_group_memberships_update parameters: - description: A UUID string identifying this dynamic group membership. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableDynamicGroupMembershipRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroupMembership' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/dynamic-groups/: delete: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_list parameters: - explode: true in: query name: content_type schema: items: type: integer type: array style: form - explode: true in: query name: content_type__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedDynamicGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableDynamicGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DynamicGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/DynamicGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableDynamicGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/DynamicGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/dynamic-groups/{id}/: delete: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_destroy parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_retrieve parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_partial_update parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedDynamicGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Dynamic Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_dynamic_groups_update parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DynamicGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/dynamic-groups/{id}/members/: get: description: List member objects of the same type as the `content_type` for this dynamic group. operationId: extras_dynamic_groups_members_retrieve parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/DynamicGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/dynamic-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_dynamic_groups_notes_list parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_dynamic_groups_notes_create parameters: - description: A UUID string identifying this dynamic group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/export-templates/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_list parameters: - in: query name: content_type schema: type: integer - in: query name: content_type__n schema: type: integer - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: owner_content_type schema: type: string - in: query name: owner_content_type__n schema: type: string - explode: true in: query name: owner_object_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: owner_object_id__re schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedExportTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableExportTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ExportTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ExportTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableExportTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ExportTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/export-templates/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_destroy parameters: - description: A UUID string identifying this export template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_retrieve parameters: - description: A UUID string identifying this export template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ExportTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_partial_update parameters: - description: A UUID string identifying this export template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedExportTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ExportTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_export_templates_update parameters: - description: A UUID string identifying this export template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ExportTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/export-templates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_export_templates_notes_list parameters: - description: A UUID string identifying this export template. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_export_templates_notes_create parameters: - description: A UUID string identifying this export template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/git-repositories/: delete: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_list parameters: - explode: true in: query name: branch schema: items: type: string type: array style: form - explode: true in: query name: branch__ic schema: items: type: string type: array style: form - explode: true in: query name: branch__ie schema: items: type: string type: array style: form - explode: true in: query name: branch__iew schema: items: type: string type: array style: form - explode: true in: query name: branch__ire schema: items: type: string type: array style: form - explode: true in: query name: branch__isw schema: items: type: string type: array style: form - explode: true in: query name: branch__n schema: items: type: string type: array style: form - explode: true in: query name: branch__nic schema: items: type: string type: array style: form - explode: true in: query name: branch__nie schema: items: type: string type: array style: form - explode: true in: query name: branch__niew schema: items: type: string type: array style: form - explode: true in: query name: branch__nire schema: items: type: string type: array style: form - explode: true in: query name: branch__nisw schema: items: type: string type: array style: form - explode: true in: query name: branch__nre schema: items: type: string type: array style: form - explode: true in: query name: branch__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: provided_contents schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: remote_url schema: items: type: string type: array style: form - explode: true in: query name: remote_url__ic schema: items: type: string type: array style: form - explode: true in: query name: remote_url__ie schema: items: type: string type: array style: form - explode: true in: query name: remote_url__iew schema: items: type: string type: array style: form - explode: true in: query name: remote_url__ire schema: items: type: string type: array style: form - explode: true in: query name: remote_url__isw schema: items: type: string type: array style: form - explode: true in: query name: remote_url__n schema: items: type: string type: array style: form - explode: true in: query name: remote_url__nic schema: items: type: string type: array style: form - explode: true in: query name: remote_url__nie schema: items: type: string type: array style: form - explode: true in: query name: remote_url__niew schema: items: type: string type: array style: form - explode: true in: query name: remote_url__nire schema: items: type: string type: array style: form - explode: true in: query name: remote_url__nisw schema: items: type: string type: array style: form - explode: true in: query name: remote_url__nre schema: items: type: string type: array style: form - explode: true in: query name: remote_url__re schema: items: type: string type: array style: form - description: Secrets group (slug) explode: true in: query name: secrets_group schema: items: type: string type: array style: form - description: Secrets group (slug) explode: true in: query name: secrets_group__n schema: items: type: string type: array style: form - description: Secrets group (ID) explode: true in: query name: secrets_group_id schema: items: format: uuid type: string type: array style: form - description: Secrets group (ID) explode: true in: query name: secrets_group_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedGitRepositoryList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableGitRepositoryRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GitRepository' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableGitRepositoryRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GitRepository' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableGitRepositoryRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GitRepository' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/git-repositories/{id}/: delete: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_destroy parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_retrieve parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GitRepository' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_partial_update parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableGitRepositoryRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GitRepository' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage the use of Git repositories as external data sources. operationId: extras_git_repositories_update parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableGitRepositoryRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GitRepository' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/git-repositories/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_git_repositories_notes_list parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_git_repositories_notes_create parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/git-repositories/{id}/sync/: post: description: Enqueue pull git repository and refresh data. operationId: extras_git_repositories_sync_create parameters: - description: A UUID string identifying this Git repository. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GitRepositoryRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GitRepository' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/graphql-queries/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_list parameters: - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedGraphQLQueryList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableGraphQLQueryRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GraphQLQuery' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_create requestBody: content: application/json: schema: $ref: '#/components/schemas/GraphQLQueryRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GraphQLQuery' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableGraphQLQueryRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GraphQLQuery' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/graphql-queries/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_destroy parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_retrieve parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GraphQLQuery' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_partial_update parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGraphQLQueryRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GraphQLQuery' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_update parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GraphQLQueryRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GraphQLQuery' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/graphql-queries/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_graphql_queries_notes_list parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_graphql_queries_notes_create parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/graphql-queries/{id}/run/: post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_graphql_queries_run_create parameters: - description: A UUID string identifying this GraphQL query. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GraphQLQueryInputRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GraphQLQueryOutput' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/image-attachments/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_list parameters: - in: query name: content_type schema: type: string - in: query name: content_type__n schema: type: string - in: query name: content_type_id schema: type: integer - in: query name: content_type_id__n schema: type: integer - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - explode: true in: query name: object_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: object_id__re schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedImageAttachmentList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableImageAttachmentRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ImageAttachment' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageAttachmentRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ImageAttachment' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableImageAttachmentRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ImageAttachment' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/image-attachments/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_destroy parameters: - description: A UUID string identifying this image attachment. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_retrieve parameters: - description: A UUID string identifying this image attachment. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ImageAttachment' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_partial_update parameters: - description: A UUID string identifying this image attachment. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedImageAttachmentRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ImageAttachment' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_image_attachments_update parameters: - description: A UUID string identifying this image attachment. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageAttachmentRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ImageAttachment' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-hooks/: delete: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_list parameters: - explode: true in: query name: content_types schema: items: type: integer type: array style: form - explode: true in: query name: content_types__n schema: items: type: integer type: array style: form - in: query name: enabled schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Job (slug or ID) explode: true in: query name: job schema: items: format: uuid type: string type: array style: form - description: Job (slug or ID) explode: true in: query name: job__n schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - in: query name: type_create schema: type: boolean - in: query name: type_delete schema: type: boolean - in: query name: type_update schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedJobHookList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableJobHookRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/JobHook' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_create requestBody: content: application/json: schema: $ref: '#/components/schemas/JobHookRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobHook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableJobHookRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/JobHook' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-hooks/{id}/: delete: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_destroy parameters: - description: A UUID string identifying this job hook. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_retrieve parameters: - description: A UUID string identifying this job hook. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobHook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_partial_update parameters: - description: A UUID string identifying this job hook. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedJobHookRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobHook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage job hooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_job_hooks_update parameters: - description: A UUID string identifying this job hook. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobHookRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobHook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-hooks/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_job_hooks_notes_list parameters: - description: A UUID string identifying this job hook. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_job_hooks_notes_create parameters: - description: A UUID string identifying this job hook. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-logs/: get: description: Retrieve a list of job log entries. operationId: extras_job_logs_list parameters: - explode: true in: query name: absolute_url schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__ic schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__ie schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__iew schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__ire schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__isw schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__n schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__nic schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__nie schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__niew schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__nire schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__nisw schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__nre schema: items: type: string type: array style: form - explode: true in: query name: absolute_url__re schema: items: type: string type: array style: form - explode: true in: query name: created schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__gt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__gte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__lt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__lte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__n schema: items: format: date-time type: string type: array style: form - explode: true in: query name: grouping schema: items: type: string type: array style: form - explode: true in: query name: grouping__ic schema: items: type: string type: array style: form - explode: true in: query name: grouping__ie schema: items: type: string type: array style: form - explode: true in: query name: grouping__iew schema: items: type: string type: array style: form - explode: true in: query name: grouping__ire schema: items: type: string type: array style: form - explode: true in: query name: grouping__isw schema: items: type: string type: array style: form - explode: true in: query name: grouping__n schema: items: type: string type: array style: form - explode: true in: query name: grouping__nic schema: items: type: string type: array style: form - explode: true in: query name: grouping__nie schema: items: type: string type: array style: form - explode: true in: query name: grouping__niew schema: items: type: string type: array style: form - explode: true in: query name: grouping__nire schema: items: type: string type: array style: form - explode: true in: query name: grouping__nisw schema: items: type: string type: array style: form - explode: true in: query name: grouping__nre schema: items: type: string type: array style: form - explode: true in: query name: grouping__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: job_result schema: format: uuid type: string - in: query name: job_result__n schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: log_level schema: type: string - in: query name: log_level__n schema: type: string - explode: true in: query name: log_object schema: items: type: string type: array style: form - explode: true in: query name: log_object__ic schema: items: type: string type: array style: form - explode: true in: query name: log_object__ie schema: items: type: string type: array style: form - explode: true in: query name: log_object__iew schema: items: type: string type: array style: form - explode: true in: query name: log_object__ire schema: items: type: string type: array style: form - explode: true in: query name: log_object__isw schema: items: type: string type: array style: form - explode: true in: query name: log_object__n schema: items: type: string type: array style: form - explode: true in: query name: log_object__nic schema: items: type: string type: array style: form - explode: true in: query name: log_object__nie schema: items: type: string type: array style: form - explode: true in: query name: log_object__niew schema: items: type: string type: array style: form - explode: true in: query name: log_object__nire schema: items: type: string type: array style: form - explode: true in: query name: log_object__nisw schema: items: type: string type: array style: form - explode: true in: query name: log_object__nre schema: items: type: string type: array style: form - explode: true in: query name: log_object__re schema: items: type: string type: array style: form - explode: true in: query name: message schema: items: type: string type: array style: form - explode: true in: query name: message__ic schema: items: type: string type: array style: form - explode: true in: query name: message__ie schema: items: type: string type: array style: form - explode: true in: query name: message__iew schema: items: type: string type: array style: form - explode: true in: query name: message__ire schema: items: type: string type: array style: form - explode: true in: query name: message__isw schema: items: type: string type: array style: form - explode: true in: query name: message__n schema: items: type: string type: array style: form - explode: true in: query name: message__nic schema: items: type: string type: array style: form - explode: true in: query name: message__nie schema: items: type: string type: array style: form - explode: true in: query name: message__niew schema: items: type: string type: array style: form - explode: true in: query name: message__nire schema: items: type: string type: array style: form - explode: true in: query name: message__nisw schema: items: type: string type: array style: form - explode: true in: query name: message__nre schema: items: type: string type: array style: form - explode: true in: query name: message__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedJobLogEntryList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-logs/{id}/: get: description: Retrieve a list of job log entries. operationId: extras_job_logs_retrieve parameters: - description: A UUID string identifying this job log entry. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobLogEntry' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-results/: delete: description: Retrieve a list of job results operationId: extras_job_results_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Retrieve a list of job results operationId: extras_job_results_list parameters: - in: query name: completed schema: format: date-time type: string - in: query name: created schema: format: date-time type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Job (slug) explode: true in: query name: job_model schema: items: type: string type: array style: form - description: Job (slug) explode: true in: query name: job_model__n schema: items: type: string type: array style: form - description: Job (ID) explode: true in: query name: job_model_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Job (ID) explode: true in: query name: job_model_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - in: query name: obj_type schema: type: string - in: query name: obj_type__n schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - in: query name: user schema: format: uuid type: string - in: query name: user__n schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedJobResultList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-results/{id}/: delete: description: Retrieve a list of job results operationId: extras_job_results_destroy parameters: - description: A UUID string identifying this job result. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Retrieve a list of job results operationId: extras_job_results_retrieve parameters: - description: A UUID string identifying this job result. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobResult' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/job-results/{id}/logs/: get: description: Retrieve a list of job results operationId: extras_job_results_logs_retrieve parameters: - description: A UUID string identifying this job result. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobResult' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/: delete: operationId: extras_jobs_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: List all known Jobs. operationId: extras_jobs_list parameters: - in: query name: approval_required schema: type: boolean - in: query name: approval_required_override schema: type: boolean - in: query name: commit_default schema: type: boolean - in: query name: commit_default_override schema: type: boolean - in: query name: description_override schema: type: boolean - in: query name: enabled schema: type: boolean - explode: true in: query name: grouping schema: items: type: string type: array style: form - explode: true in: query name: grouping__ic schema: items: type: string type: array style: form - explode: true in: query name: grouping__ie schema: items: type: string type: array style: form - explode: true in: query name: grouping__iew schema: items: type: string type: array style: form - explode: true in: query name: grouping__ire schema: items: type: string type: array style: form - explode: true in: query name: grouping__isw schema: items: type: string type: array style: form - explode: true in: query name: grouping__n schema: items: type: string type: array style: form - explode: true in: query name: grouping__nic schema: items: type: string type: array style: form - explode: true in: query name: grouping__nie schema: items: type: string type: array style: form - explode: true in: query name: grouping__niew schema: items: type: string type: array style: form - explode: true in: query name: grouping__nire schema: items: type: string type: array style: form - explode: true in: query name: grouping__nisw schema: items: type: string type: array style: form - explode: true in: query name: grouping__nre schema: items: type: string type: array style: form - explode: true in: query name: grouping__re schema: items: type: string type: array style: form - in: query name: grouping_override schema: type: boolean - in: query name: has_sensitive_variables schema: type: boolean - in: query name: has_sensitive_variables_override schema: type: boolean - in: query name: hidden schema: type: boolean - in: query name: hidden_override schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: installed schema: type: boolean - in: query name: is_job_hook_receiver schema: type: boolean - explode: true in: query name: job_class_name schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__ic schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__ie schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__iew schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__ire schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__isw schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__n schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__nic schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__nie schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__niew schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__nire schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__nre schema: items: type: string type: array style: form - explode: true in: query name: job_class_name__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: module_name schema: items: type: string type: array style: form - explode: true in: query name: module_name__ic schema: items: type: string type: array style: form - explode: true in: query name: module_name__ie schema: items: type: string type: array style: form - explode: true in: query name: module_name__iew schema: items: type: string type: array style: form - explode: true in: query name: module_name__ire schema: items: type: string type: array style: form - explode: true in: query name: module_name__isw schema: items: type: string type: array style: form - explode: true in: query name: module_name__n schema: items: type: string type: array style: form - explode: true in: query name: module_name__nic schema: items: type: string type: array style: form - explode: true in: query name: module_name__nie schema: items: type: string type: array style: form - explode: true in: query name: module_name__niew schema: items: type: string type: array style: form - explode: true in: query name: module_name__nire schema: items: type: string type: array style: form - explode: true in: query name: module_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: module_name__nre schema: items: type: string type: array style: form - explode: true in: query name: module_name__re schema: items: type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - in: query name: name_override schema: type: boolean - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: read_only schema: type: boolean - in: query name: read_only_override schema: type: boolean - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: soft_time_limit schema: items: format: float type: number type: array style: form - explode: true in: query name: soft_time_limit__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: soft_time_limit__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: soft_time_limit__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: soft_time_limit__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: soft_time_limit__n schema: items: format: float type: number type: array style: form - in: query name: soft_time_limit_override schema: type: boolean - description: Source of the Python code for this job - local, Git repository, or plugins in: query name: source schema: type: string - description: Source of the Python code for this job - local, Git repository, or plugins in: query name: source__n schema: type: string - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - explode: true in: query name: time_limit schema: items: format: float type: number type: array style: form - explode: true in: query name: time_limit__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: time_limit__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: time_limit__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: time_limit__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: time_limit__n schema: items: format: float type: number type: array style: form - in: query name: time_limit_override schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedJobList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: operationId: extras_jobs_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableJobRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Job' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: operationId: extras_jobs_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableJobRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Job' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/{class_path}/: get: deprecated: true description: 'Get details of a Job as identified by its class-path. This API endpoint is deprecated; it is recommended to use the extras_jobs_read endpoint instead.' operationId: extras_jobs_read_deprecated parameters: - in: path name: class_path required: true schema: pattern: ^[^/]+/[^/]+/[^/]+$ type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobClassDetail' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/{class_path}/run/: post: deprecated: true description: 'Run a Job as identified by its class-path. This API endpoint is deprecated; it is recommended to use the extras_jobs_run endpoint instead.' operationId: extras_jobs_run_deprecated parameters: - in: path name: class_path required: true schema: pattern: ^[^/]+/[^/]+/[^/]+$ type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobInputRequest' multipart/form-data: schema: $ref: '#/components/schemas/JobInputRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobClassDetail' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/{id}/: delete: operationId: extras_jobs_destroy parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: operationId: extras_jobs_retrieve parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Job' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: operationId: extras_jobs_partial_update parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedJobRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Job' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: operationId: extras_jobs_update parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Job' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_jobs_notes_list parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_jobs_notes_create parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/{id}/run/: post: description: Run the specified Job. operationId: extras_jobs_run_create parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/JobInputRequest' multipart/form-data: schema: $ref: '#/components/schemas/JobMultiPartInputRequest' responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobRunResponse' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/jobs/{id}/variables/: get: description: Get details of the input variables that may/must be specified to run a particular Job. operationId: extras_jobs_variables_list parameters: - description: A UUID string identifying this job. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedJobVariableList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/notes/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_list parameters: - explode: true in: query name: assigned_object_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_object_id__re schema: items: format: uuid type: string type: array style: form - in: query name: assigned_object_type schema: type: string - in: query name: assigned_object_type__n schema: type: string - in: query name: assigned_object_type_id schema: type: integer - in: query name: assigned_object_type_id__n schema: type: integer - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: note schema: items: type: string type: array style: form - explode: true in: query name: note__ic schema: items: type: string type: array style: form - explode: true in: query name: note__ie schema: items: type: string type: array style: form - explode: true in: query name: note__iew schema: items: type: string type: array style: form - explode: true in: query name: note__ire schema: items: type: string type: array style: form - explode: true in: query name: note__isw schema: items: type: string type: array style: form - explode: true in: query name: note__n schema: items: type: string type: array style: form - explode: true in: query name: note__nic schema: items: type: string type: array style: form - explode: true in: query name: note__nie schema: items: type: string type: array style: form - explode: true in: query name: note__niew schema: items: type: string type: array style: form - explode: true in: query name: note__nire schema: items: type: string type: array style: form - explode: true in: query name: note__nisw schema: items: type: string type: array style: form - explode: true in: query name: note__nre schema: items: type: string type: array style: form - explode: true in: query name: note__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: User (username or ID) explode: true in: query name: user schema: items: format: uuid type: string type: array style: form - description: User (username or ID) explode: true in: query name: user__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: user_name schema: items: type: string type: array style: form - explode: true in: query name: user_name__ic schema: items: type: string type: array style: form - explode: true in: query name: user_name__ie schema: items: type: string type: array style: form - explode: true in: query name: user_name__iew schema: items: type: string type: array style: form - explode: true in: query name: user_name__ire schema: items: type: string type: array style: form - explode: true in: query name: user_name__isw schema: items: type: string type: array style: form - explode: true in: query name: user_name__n schema: items: type: string type: array style: form - explode: true in: query name: user_name__nic schema: items: type: string type: array style: form - explode: true in: query name: user_name__nie schema: items: type: string type: array style: form - explode: true in: query name: user_name__niew schema: items: type: string type: array style: form - explode: true in: query name: user_name__nire schema: items: type: string type: array style: form - explode: true in: query name: user_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: user_name__nre schema: items: type: string type: array style: form - explode: true in: query name: user_name__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableNoteRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Note' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_create requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableNoteRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Note' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/notes/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_destroy parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_retrieve parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_partial_update parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedNoteRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_notes_update parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/object-changes/: get: description: Retrieve a list of recent changes. operationId: extras_object_changes_list parameters: - in: query name: action schema: type: string - in: query name: action__n schema: type: string - explode: true in: query name: changed_object_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: changed_object_id__re schema: items: format: uuid type: string type: array style: form - in: query name: changed_object_type schema: type: string - in: query name: changed_object_type__n schema: type: string - in: query name: changed_object_type_id schema: type: integer - in: query name: changed_object_type_id__n schema: type: integer - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: object_repr schema: items: type: string type: array style: form - explode: true in: query name: object_repr__ic schema: items: type: string type: array style: form - explode: true in: query name: object_repr__ie schema: items: type: string type: array style: form - explode: true in: query name: object_repr__iew schema: items: type: string type: array style: form - explode: true in: query name: object_repr__ire schema: items: type: string type: array style: form - explode: true in: query name: object_repr__isw schema: items: type: string type: array style: form - explode: true in: query name: object_repr__n schema: items: type: string type: array style: form - explode: true in: query name: object_repr__nic schema: items: type: string type: array style: form - explode: true in: query name: object_repr__nie schema: items: type: string type: array style: form - explode: true in: query name: object_repr__niew schema: items: type: string type: array style: form - explode: true in: query name: object_repr__nire schema: items: type: string type: array style: form - explode: true in: query name: object_repr__nisw schema: items: type: string type: array style: form - explode: true in: query name: object_repr__nre schema: items: type: string type: array style: form - explode: true in: query name: object_repr__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: request_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: request_id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: time schema: items: format: date-time type: string type: array style: form - explode: true in: query name: time__gt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: time__gte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: time__lt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: time__lte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: time__n schema: items: format: date-time type: string type: array style: form - description: User name explode: true in: query name: user schema: items: type: string type: array style: form - description: User name explode: true in: query name: user__n schema: items: type: string type: array style: form - description: User (ID) explode: true in: query name: user_id schema: items: format: uuid nullable: true type: string type: array style: form - description: User (ID) explode: true in: query name: user_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: user_name schema: items: type: string type: array style: form - explode: true in: query name: user_name__ic schema: items: type: string type: array style: form - explode: true in: query name: user_name__ie schema: items: type: string type: array style: form - explode: true in: query name: user_name__iew schema: items: type: string type: array style: form - explode: true in: query name: user_name__ire schema: items: type: string type: array style: form - explode: true in: query name: user_name__isw schema: items: type: string type: array style: form - explode: true in: query name: user_name__n schema: items: type: string type: array style: form - explode: true in: query name: user_name__nic schema: items: type: string type: array style: form - explode: true in: query name: user_name__nie schema: items: type: string type: array style: form - explode: true in: query name: user_name__niew schema: items: type: string type: array style: form - explode: true in: query name: user_name__nire schema: items: type: string type: array style: form - explode: true in: query name: user_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: user_name__nre schema: items: type: string type: array style: form - explode: true in: query name: user_name__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedObjectChangeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/object-changes/{id}/: get: description: Retrieve a list of recent changes. operationId: extras_object_changes_retrieve parameters: - description: A UUID string identifying this object change. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ObjectChange' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/relationship-associations/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_list parameters: - explode: true in: query name: destination_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: destination_type schema: items: type: integer type: array style: form - explode: true in: query name: destination_type__n schema: items: type: integer type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: peer_id schema: items: format: uuid type: string type: array style: form - description: Relationship (slug) explode: true in: query name: relationship schema: items: type: string type: array style: form - description: Relationship (slug) explode: true in: query name: relationship__n schema: items: type: string type: array style: form - explode: true in: query name: source_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: source_type schema: items: type: integer type: array style: form - explode: true in: query name: source_type__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRelationshipAssociationList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRelationshipAssociationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RelationshipAssociation' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRelationshipAssociationRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RelationshipAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRelationshipAssociationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RelationshipAssociation' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/relationship-associations/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_destroy parameters: - description: A UUID string identifying this relationship association. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_retrieve parameters: - description: A UUID string identifying this relationship association. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RelationshipAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_partial_update parameters: - description: A UUID string identifying this relationship association. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRelationshipAssociationRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RelationshipAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationship_associations_update parameters: - description: A UUID string identifying this relationship association. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRelationshipAssociationRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RelationshipAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/relationships/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_list parameters: - explode: true in: query name: destination_type schema: items: type: integer type: array style: form - explode: true in: query name: destination_type__n schema: items: type: integer type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: source_type schema: items: type: integer type: array style: form - explode: true in: query name: source_type__n schema: items: type: integer type: array style: form - description: Cardinality of this relationship in: query name: type schema: type: string - description: Cardinality of this relationship in: query name: type__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRelationshipList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRelationshipRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Relationship' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_create requestBody: content: application/json: schema: $ref: '#/components/schemas/RelationshipRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Relationship' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRelationshipRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Relationship' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/relationships/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_destroy parameters: - description: A UUID string identifying this relationship. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_retrieve parameters: - description: A UUID string identifying this relationship. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Relationship' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_partial_update parameters: - description: A UUID string identifying this relationship. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRelationshipRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Relationship' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: extras_relationships_update parameters: - description: A UUID string identifying this relationship. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RelationshipRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Relationship' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/relationships/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_relationships_notes_list parameters: - description: A UUID string identifying this relationship. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_relationships_notes_create parameters: - description: A UUID string identifying this relationship. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/scheduled-jobs/: get: description: Retrieve a list of scheduled jobs operationId: extras_scheduled_jobs_list parameters: - in: query name: first_run schema: format: date-time type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Job (slug) explode: true in: query name: job_model schema: items: type: string type: array style: form - description: Job (slug) explode: true in: query name: job_model__n schema: items: type: string type: array style: form - description: Job (ID) explode: true in: query name: job_model_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Job (ID) explode: true in: query name: job_model_id__n schema: items: format: uuid nullable: true type: string type: array style: form - in: query name: last_run schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: total_run_count schema: items: type: integer type: array style: form - explode: true in: query name: total_run_count__gt schema: items: type: integer type: array style: form - explode: true in: query name: total_run_count__gte schema: items: type: integer type: array style: form - explode: true in: query name: total_run_count__lt schema: items: type: integer type: array style: form - explode: true in: query name: total_run_count__lte schema: items: type: integer type: array style: form - explode: true in: query name: total_run_count__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedScheduledJobList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/scheduled-jobs/{id}/: get: description: Retrieve a list of scheduled jobs operationId: extras_scheduled_jobs_retrieve parameters: - description: A UUID string identifying this scheduled job. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ScheduledJob' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/scheduled-jobs/{id}/approve/: post: description: Retrieve a list of scheduled jobs operationId: extras_scheduled_jobs_approve_create parameters: - description: force execution even if start time has passed in: query name: force schema: type: boolean - description: A UUID string identifying this scheduled job. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ScheduledJob' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/scheduled-jobs/{id}/deny/: post: description: Retrieve a list of scheduled jobs operationId: extras_scheduled_jobs_deny_create parameters: - description: A UUID string identifying this scheduled job. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ScheduledJob' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/scheduled-jobs/{id}/dry-run/: post: description: Retrieve a list of scheduled jobs operationId: extras_scheduled_jobs_dry_run_create parameters: - description: A UUID string identifying this scheduled job. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/JobResult' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets-groups-associations/: delete: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_list parameters: - explode: true in: query name: access_type schema: items: type: string type: array style: form - explode: true in: query name: access_type__n schema: items: type: string type: array style: form - description: Group (slug) explode: true in: query name: group schema: items: type: string type: array style: form - description: Group (slug) explode: true in: query name: group__n schema: items: type: string type: array style: form - description: Group (ID) explode: true in: query name: group_id schema: items: format: uuid type: string type: array style: form - description: Group (ID) explode: true in: query name: group_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Secret (slug) explode: true in: query name: secret schema: items: type: string type: array style: form - description: Secret (slug) explode: true in: query name: secret__n schema: items: type: string type: array style: form - description: Secret (ID) explode: true in: query name: secret_id schema: items: format: uuid type: string type: array style: form - description: Secret (ID) explode: true in: query name: secret_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: secret_type schema: items: type: string type: array style: form - explode: true in: query name: secret_type__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedSecretsGroupAssociationList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableSecretsGroupAssociationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SecretsGroupAssociation' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSecretsGroupAssociationRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroupAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableSecretsGroupAssociationRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SecretsGroupAssociation' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets-groups-associations/{id}/: delete: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_destroy parameters: - description: A UUID string identifying this secrets group association. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_retrieve parameters: - description: A UUID string identifying this secrets group association. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroupAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_partial_update parameters: - description: A UUID string identifying this secrets group association. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableSecretsGroupAssociationRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroupAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Secrets Group Associations through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_associations_update parameters: - description: A UUID string identifying this secrets group association. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSecretsGroupAssociationRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroupAssociation' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets-groups/: delete: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedSecretsGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableSecretsGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SecretsGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretsGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableSecretsGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SecretsGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets-groups/{id}/: delete: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_destroy parameters: - description: A UUID string identifying this secrets group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_retrieve parameters: - description: A UUID string identifying this secrets group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_partial_update parameters: - description: A UUID string identifying this secrets group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedSecretsGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Secrets Groups through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_groups_update parameters: - description: A UUID string identifying this secrets group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretsGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SecretsGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_secrets_groups_notes_list parameters: - description: A UUID string identifying this secrets group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_secrets_groups_notes_create parameters: - description: A UUID string identifying this secrets group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets/: delete: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: provider schema: items: type: string type: array style: form - explode: true in: query name: provider__ic schema: items: type: string type: array style: form - explode: true in: query name: provider__ie schema: items: type: string type: array style: form - explode: true in: query name: provider__iew schema: items: type: string type: array style: form - explode: true in: query name: provider__ire schema: items: type: string type: array style: form - explode: true in: query name: provider__isw schema: items: type: string type: array style: form - explode: true in: query name: provider__n schema: items: type: string type: array style: form - explode: true in: query name: provider__nic schema: items: type: string type: array style: form - explode: true in: query name: provider__nie schema: items: type: string type: array style: form - explode: true in: query name: provider__niew schema: items: type: string type: array style: form - explode: true in: query name: provider__nire schema: items: type: string type: array style: form - explode: true in: query name: provider__nisw schema: items: type: string type: array style: form - explode: true in: query name: provider__nre schema: items: type: string type: array style: form - explode: true in: query name: provider__re schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedSecretList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableSecretRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Secret' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_create requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Secret' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableSecretRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Secret' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets/{id}/: delete: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_destroy parameters: - description: A UUID string identifying this secret. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_retrieve parameters: - description: A UUID string identifying this secret. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Secret' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_partial_update parameters: - description: A UUID string identifying this secret. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedSecretRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Secret' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Secrets through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_secrets_update parameters: - description: A UUID string identifying this secret. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SecretRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Secret' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/secrets/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_secrets_notes_list parameters: - description: A UUID string identifying this secret. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_secrets_notes_create parameters: - description: A UUID string identifying this secret. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/statuses/: delete: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_list parameters: - explode: true in: query name: color schema: items: type: string type: array style: form - explode: true in: query name: color__ic schema: items: type: string type: array style: form - explode: true in: query name: color__ie schema: items: type: string type: array style: form - explode: true in: query name: color__iew schema: items: type: string type: array style: form - explode: true in: query name: color__ire schema: items: type: string type: array style: form - explode: true in: query name: color__isw schema: items: type: string type: array style: form - explode: true in: query name: color__n schema: items: type: string type: array style: form - explode: true in: query name: color__nic schema: items: type: string type: array style: form - explode: true in: query name: color__nie schema: items: type: string type: array style: form - explode: true in: query name: color__niew schema: items: type: string type: array style: form - explode: true in: query name: color__nire schema: items: type: string type: array style: form - explode: true in: query name: color__nisw schema: items: type: string type: array style: form - explode: true in: query name: color__nre schema: items: type: string type: array style: form - explode: true in: query name: color__re schema: items: type: string type: array style: form - explode: true in: query name: content_types schema: items: type: integer type: array style: form - explode: true in: query name: content_types__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedStatusList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableStatusRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Status' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_create requestBody: content: application/json: schema: $ref: '#/components/schemas/StatusRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Status' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableStatusRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Status' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/statuses/{id}/: delete: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_destroy parameters: - description: A UUID string identifying this status. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_retrieve parameters: - description: A UUID string identifying this status. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Status' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_partial_update parameters: - description: A UUID string identifying this status. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedStatusRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Status' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: View and manage custom status choices for objects with a `status` field. operationId: extras_statuses_update parameters: - description: A UUID string identifying this status. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StatusRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Status' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/statuses/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_statuses_notes_list parameters: - description: A UUID string identifying this status. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_statuses_notes_create parameters: - description: A UUID string identifying this status. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/tags/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_list parameters: - explode: true in: query name: color schema: items: type: string type: array style: form - explode: true in: query name: color__ic schema: items: type: string type: array style: form - explode: true in: query name: color__ie schema: items: type: string type: array style: form - explode: true in: query name: color__iew schema: items: type: string type: array style: form - explode: true in: query name: color__ire schema: items: type: string type: array style: form - explode: true in: query name: color__isw schema: items: type: string type: array style: form - explode: true in: query name: color__n schema: items: type: string type: array style: form - explode: true in: query name: color__nic schema: items: type: string type: array style: form - explode: true in: query name: color__nie schema: items: type: string type: array style: form - explode: true in: query name: color__niew schema: items: type: string type: array style: form - explode: true in: query name: color__nire schema: items: type: string type: array style: form - explode: true in: query name: color__nisw schema: items: type: string type: array style: form - explode: true in: query name: color__nre schema: items: type: string type: array style: form - explode: true in: query name: color__re schema: items: type: string type: array style: form - explode: true in: query name: content_types schema: items: type: integer type: array style: form - explode: true in: query name: content_types__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedTagSerializerVersion13List' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableTagSerializerVersion13Request' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/TagSerializerVersion13' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_create requestBody: content: application/json: schema: $ref: '#/components/schemas/TagSerializerVersion13Request' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TagSerializerVersion13' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableTagSerializerVersion13Request' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/TagSerializerVersion13' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/tags/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_destroy parameters: - description: A UUID string identifying this tag. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_retrieve parameters: - description: A UUID string identifying this tag. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TagSerializerVersion13' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_partial_update parameters: - description: A UUID string identifying this tag. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTagSerializerVersion13Request' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TagSerializerVersion13' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: extras_tags_update parameters: - description: A UUID string identifying this tag. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TagSerializerVersion13Request' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TagSerializerVersion13' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/tags/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_tags_notes_list parameters: - description: A UUID string identifying this tag. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_tags_notes_create parameters: - description: A UUID string identifying this tag. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/webhooks/: delete: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_list parameters: - explode: true in: query name: content_types schema: items: type: integer type: array style: form - explode: true in: query name: content_types__n schema: items: type: integer type: array style: form - in: query name: enabled schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: payload_url schema: items: type: string type: array style: form - explode: true in: query name: payload_url__ic schema: items: type: string type: array style: form - explode: true in: query name: payload_url__ie schema: items: type: string type: array style: form - explode: true in: query name: payload_url__iew schema: items: type: string type: array style: form - explode: true in: query name: payload_url__ire schema: items: type: string type: array style: form - explode: true in: query name: payload_url__isw schema: items: type: string type: array style: form - explode: true in: query name: payload_url__n schema: items: type: string type: array style: form - explode: true in: query name: payload_url__nic schema: items: type: string type: array style: form - explode: true in: query name: payload_url__nie schema: items: type: string type: array style: form - explode: true in: query name: payload_url__niew schema: items: type: string type: array style: form - explode: true in: query name: payload_url__nire schema: items: type: string type: array style: form - explode: true in: query name: payload_url__nisw schema: items: type: string type: array style: form - explode: true in: query name: payload_url__nre schema: items: type: string type: array style: form - explode: true in: query name: payload_url__re schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - in: query name: type_create schema: type: boolean - in: query name: type_delete schema: type: boolean - in: query name: type_update schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedWebhookList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableWebhookRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Webhook' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Webhook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableWebhookRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Webhook' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/webhooks/{id}/: delete: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_destroy parameters: - description: A UUID string identifying this webhook. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - extras get: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_retrieve parameters: - description: A UUID string identifying this webhook. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Webhook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras patch: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_partial_update parameters: - description: A UUID string identifying this webhook. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWebhookRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Webhook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras put: description: Manage Webhooks through DELETE, GET, POST, PUT, and PATCH requests. operationId: extras_webhooks_update parameters: - description: A UUID string identifying this webhook. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Webhook' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /extras/webhooks/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: extras_webhooks_notes_list parameters: - description: A UUID string identifying this webhook. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras post: description: API methods for returning or creating notes on an object. operationId: extras_webhooks_notes_create parameters: - description: A UUID string identifying this webhook. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - extras /graphql/: post: description: Query the database using a GraphQL query operationId: graphql_create requestBody: content: application/json: schema: $ref: '#/components/schemas/GraphQLAPIRequest' required: true responses: '200': content: application/json; version=1.3: schema: properties: data: type: object type: object description: '' '400': content: application/json; version=1.3: schema: properties: errors: items: type: object type: array type: object description: '' security: - cookieAuth: [] - tokenAuth: [] - {} tags: - graphql /ipam/aggregates/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: date_added schema: items: format: date type: string type: array style: form - explode: true in: query name: date_added__gt schema: items: format: date type: string type: array style: form - explode: true in: query name: date_added__gte schema: items: format: date type: string type: array style: form - explode: true in: query name: date_added__lt schema: items: format: date type: string type: array style: form - explode: true in: query name: date_added__lte schema: items: format: date type: string type: array style: form - explode: true in: query name: date_added__n schema: items: format: date type: string type: array style: form - description: Family in: query name: family schema: type: number - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Prefix in: query name: prefix schema: type: string - description: Search in: query name: q schema: type: string - description: RIR (slug) explode: true in: query name: rir schema: items: type: string type: array style: form - description: RIR (slug) explode: true in: query name: rir__n schema: items: type: string type: array style: form - description: RIR (ID) explode: true in: query name: rir_id schema: items: format: uuid type: string type: array style: form - description: RIR (ID) explode: true in: query name: rir_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAggregateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableAggregateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Aggregate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAggregateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Aggregate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableAggregateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Aggregate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/aggregates/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_destroy parameters: - description: A UUID string identifying this aggregate. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_retrieve parameters: - description: A UUID string identifying this aggregate. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Aggregate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_partial_update parameters: - description: A UUID string identifying this aggregate. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableAggregateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Aggregate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_aggregates_update parameters: - description: A UUID string identifying this aggregate. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAggregateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Aggregate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/aggregates/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_aggregates_notes_list parameters: - description: A UUID string identifying this aggregate. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_aggregates_notes_create parameters: - description: A UUID string identifying this aggregate. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/ip-addresses/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_list parameters: - description: Address explode: true in: query name: address schema: items: type: string type: array style: form - description: Is assigned to an interface in: query name: assigned_to_interface schema: type: boolean - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device (name) explode: true in: query name: device schema: items: type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: dns_name schema: items: type: string type: array style: form - explode: true in: query name: dns_name__ic schema: items: type: string type: array style: form - explode: true in: query name: dns_name__ie schema: items: type: string type: array style: form - explode: true in: query name: dns_name__iew schema: items: type: string type: array style: form - explode: true in: query name: dns_name__ire schema: items: type: string type: array style: form - explode: true in: query name: dns_name__isw schema: items: type: string type: array style: form - explode: true in: query name: dns_name__n schema: items: type: string type: array style: form - explode: true in: query name: dns_name__nic schema: items: type: string type: array style: form - explode: true in: query name: dns_name__nie schema: items: type: string type: array style: form - explode: true in: query name: dns_name__niew schema: items: type: string type: array style: form - explode: true in: query name: dns_name__nire schema: items: type: string type: array style: form - explode: true in: query name: dns_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: dns_name__nre schema: items: type: string type: array style: form - explode: true in: query name: dns_name__re schema: items: type: string type: array style: form - description: Family in: query name: family schema: type: number - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Interface (name) explode: true in: query name: interface schema: items: type: string type: array style: form - description: Interface (name) explode: true in: query name: interface__n schema: items: type: string type: array style: form - description: Interface (ID) explode: true in: query name: interface_id schema: items: format: uuid type: string type: array style: form - description: Interface (ID) explode: true in: query name: interface_id__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Mask length in: query name: mask_length schema: type: number - description: Routing Instance UUID explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance schema: items: type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nautobot_bgp_models_ips_bgp_routing_instance__re schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent prefix in: query name: parent schema: type: string - description: VRF (RD) in: query name: present_in_vrf schema: nullable: true title: Route distinguisher type: string - description: VRF in: query name: present_in_vrf_id schema: format: uuid type: string - description: Search in: query name: q schema: type: string - description: The functional role of this IP explode: true in: query name: role schema: items: type: string type: array style: form - description: The functional role of this IP explode: true in: query name: role__n schema: items: type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Virtual machine (name) explode: true in: query name: virtual_machine schema: items: type: string type: array style: form - description: Virtual machine (ID) explode: true in: query name: virtual_machine_id schema: items: format: uuid type: string type: array style: form - description: VM interface (name) explode: true in: query name: vminterface schema: items: type: string type: array style: form - description: VM interface (name) explode: true in: query name: vminterface__n schema: items: type: string type: array style: form - description: VM interface (ID) explode: true in: query name: vminterface_id schema: items: format: uuid type: string type: array style: form - description: VM interface (ID) explode: true in: query name: vminterface_id__n schema: items: format: uuid type: string type: array style: form - description: VRF (RD) explode: true in: query name: vrf schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: VRF (RD) explode: true in: query name: vrf__n schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: VRF explode: true in: query name: vrf_id schema: items: format: uuid nullable: true type: string type: array style: form - description: VRF explode: true in: query name: vrf_id__n schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedIPAddressList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableIPAddressRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/IPAddress' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPAddressRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPAddress' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableIPAddressRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/IPAddress' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/ip-addresses/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_destroy parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_retrieve parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPAddress' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_partial_update parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIPAddressRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPAddress' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_ip_addresses_update parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPAddressRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPAddress' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/ip-addresses/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_ip_addresses_notes_list parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_ip_addresses_notes_create parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/prefixes/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_list parameters: - description: Prefixes which contain this prefix or IP in: query name: contains schema: type: string - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Family in: query name: family schema: type: number - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: is_pool schema: type: boolean - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - description: mask_length in: query name: mask_length schema: type: number - description: mask_length__gte in: query name: mask_length__gte schema: type: number - description: mask_length__lte in: query name: mask_length__lte schema: type: number - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Prefix in: query name: prefix schema: type: string - description: VRF (RD) in: query name: present_in_vrf schema: nullable: true title: Route distinguisher type: string - description: VRF in: query name: present_in_vrf_id schema: format: uuid type: string - description: Search in: query name: q schema: type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (slug) explode: true in: query name: role__n schema: items: type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: VLAN (ID) explode: true in: query name: vlan_id schema: items: format: uuid nullable: true type: string type: array style: form - description: VLAN (ID) explode: true in: query name: vlan_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: VLAN number (1-4095) in: query name: vlan_vid schema: type: integer - description: VRF (RD) explode: true in: query name: vrf schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: VRF (RD) explode: true in: query name: vrf__n schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: VRF explode: true in: query name: vrf_id schema: items: format: uuid nullable: true type: string type: array style: form - description: VRF explode: true in: query name: vrf_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Within prefix in: query name: within schema: type: string - description: Within and including prefix in: query name: within_include schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPrefixList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePrefixRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Prefix' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePrefixRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Prefix' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePrefixRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Prefix' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/prefixes/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_destroy parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_retrieve parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Prefix' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_partial_update parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePrefixRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Prefix' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_prefixes_update parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePrefixRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Prefix' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/prefixes/{id}/available-ips/: get: description: 'A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated. The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where multiple insertions can occur.' operationId: ipam_prefixes_available_ips_list parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAvailableIPList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated. The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where multiple insertions can occur.' operationId: ipam_prefixes_available_ips_create parameters: - description: A UUID string identifying this IP address. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAvailableIPList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/prefixes/{id}/available-prefixes/: get: description: 'A convenience method for returning available child prefixes within a parent. The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where multiple insertions can occur.' operationId: ipam_prefixes_available_prefixes_list parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAvailablePrefixList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'A convenience method for returning available child prefixes within a parent. The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where multiple insertions can occur.' operationId: ipam_prefixes_available_prefixes_create parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PrefixLengthRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Prefix' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/prefixes/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_prefixes_notes_list parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_prefixes_notes_create parameters: - description: A UUID string identifying this prefix. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/rirs/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: is_private schema: type: boolean - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRIRList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRIRRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RIR' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_create requestBody: content: application/json: schema: $ref: '#/components/schemas/RIRRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RIR' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRIRRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RIR' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/rirs/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_destroy parameters: - description: A UUID string identifying this RIR. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_retrieve parameters: - description: A UUID string identifying this RIR. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RIR' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_partial_update parameters: - description: A UUID string identifying this RIR. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRIRRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RIR' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_rirs_update parameters: - description: A UUID string identifying this RIR. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RIRRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RIR' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/rirs/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_rirs_notes_list parameters: - description: A UUID string identifying this RIR. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_rirs_notes_create parameters: - description: A UUID string identifying this RIR. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/roles/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRoleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Role' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_create requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Role' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Role' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/roles/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_destroy parameters: - description: A UUID string identifying this role. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_retrieve parameters: - description: A UUID string identifying this role. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Role' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_partial_update parameters: - description: A UUID string identifying this role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRoleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Role' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_roles_update parameters: - description: A UUID string identifying this role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Role' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/roles/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_roles_notes_list parameters: - description: A UUID string identifying this role. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_roles_notes_create parameters: - description: A UUID string identifying this role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/route-targets/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Export VRF (RD) explode: true in: query name: exporting_vrf schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: Export VRF (RD) explode: true in: query name: exporting_vrf__n schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: Exporting VRF explode: true in: query name: exporting_vrf_id schema: items: format: uuid type: string type: array style: form - description: Exporting VRF explode: true in: query name: exporting_vrf_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Import VRF (RD) explode: true in: query name: importing_vrf schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: Import VRF (RD) explode: true in: query name: importing_vrf__n schema: items: nullable: true title: Route distinguisher type: string type: array style: form - description: Importing VRF explode: true in: query name: importing_vrf_id schema: items: format: uuid type: string type: array style: form - description: Importing VRF explode: true in: query name: importing_vrf_id__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRouteTargetList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRouteTargetRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RouteTarget' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRouteTargetRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RouteTarget' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRouteTargetRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RouteTarget' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/route-targets/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_destroy parameters: - description: A UUID string identifying this route target. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_retrieve parameters: - description: A UUID string identifying this route target. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RouteTarget' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_partial_update parameters: - description: A UUID string identifying this route target. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableRouteTargetRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RouteTarget' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_route_targets_update parameters: - description: A UUID string identifying this route target. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableRouteTargetRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RouteTarget' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/route-targets/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_route_targets_notes_list parameters: - description: A UUID string identifying this route target. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_route_targets_notes_create parameters: - description: A UUID string identifying this route target. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/services/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: port schema: type: number - in: query name: protocol schema: type: string - in: query name: protocol__n schema: type: string - description: Search in: query name: q schema: type: string - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Virtual machine (name) explode: true in: query name: virtual_machine schema: items: type: string type: array style: form - description: Virtual machine (name) explode: true in: query name: virtual_machine__n schema: items: type: string type: array style: form - description: Virtual machine (ID) explode: true in: query name: virtual_machine_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Virtual machine (ID) explode: true in: query name: virtual_machine_id__n schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedServiceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableServiceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Service' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableServiceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Service' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableServiceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Service' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/services/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_destroy parameters: - description: A UUID string identifying this service. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_retrieve parameters: - description: A UUID string identifying this service. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Service' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_partial_update parameters: - description: A UUID string identifying this service. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableServiceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Service' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_services_update parameters: - description: A UUID string identifying this service. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableServiceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Service' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/services/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_services_notes_list parameters: - description: A UUID string identifying this service. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_services_notes_create parameters: - description: A UUID string identifying this service. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vlan-groups/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVLANGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVLANGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VLANGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVLANGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLANGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVLANGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VLANGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vlan-groups/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_destroy parameters: - description: A UUID string identifying this VLAN group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_retrieve parameters: - description: A UUID string identifying this VLAN group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLANGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_partial_update parameters: - description: A UUID string identifying this VLAN group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVLANGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLANGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vlan_groups_update parameters: - description: A UUID string identifying this VLAN group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVLANGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLANGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vlan-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_vlan_groups_notes_list parameters: - description: A UUID string identifying this VLAN group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_vlan_groups_notes_create parameters: - description: A UUID string identifying this VLAN group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vlans/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_list parameters: - description: Device (ID) in: query name: available_on_device schema: format: uuid type: string - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Group explode: true in: query name: group schema: items: type: string type: array style: form - description: Group explode: true in: query name: group__n schema: items: type: string type: array style: form - description: Group (ID) explode: true in: query name: group_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Group (ID) explode: true in: query name: group_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (slug) explode: true in: query name: role__n schema: items: type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: vid schema: items: type: integer type: array style: form - explode: true in: query name: vid__gt schema: items: type: integer type: array style: form - explode: true in: query name: vid__gte schema: items: type: integer type: array style: form - explode: true in: query name: vid__lt schema: items: type: integer type: array style: form - explode: true in: query name: vid__lte schema: items: type: integer type: array style: form - explode: true in: query name: vid__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVLANList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVLANRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VLAN' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVLANRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLAN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVLANRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VLAN' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vlans/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_destroy parameters: - description: A UUID string identifying this VLAN. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_retrieve parameters: - description: A UUID string identifying this VLAN. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLAN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_partial_update parameters: - description: A UUID string identifying this VLAN. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVLANRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLAN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: ipam_vlans_update parameters: - description: A UUID string identifying this VLAN. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVLANRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VLAN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vlans/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_vlans_notes_list parameters: - description: A UUID string identifying this VLAN. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_vlans_notes_create parameters: - description: A UUID string identifying this VLAN. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vrfs/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: enforce_unique schema: type: boolean - description: Export target (name) explode: true in: query name: export_target schema: items: type: string type: array style: form - description: Export target (name) explode: true in: query name: export_target__n schema: items: type: string type: array style: form - description: Export target explode: true in: query name: export_target_id schema: items: format: uuid type: string type: array style: form - description: Export target explode: true in: query name: export_target_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Import target (name) explode: true in: query name: import_target schema: items: type: string type: array style: form - description: Import target (name) explode: true in: query name: import_target__n schema: items: type: string type: array style: form - description: Import target explode: true in: query name: import_target_id schema: items: format: uuid type: string type: array style: form - description: Import target explode: true in: query name: import_target_id__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: rd schema: items: type: string type: array style: form - explode: true in: query name: rd__ic schema: items: type: string type: array style: form - explode: true in: query name: rd__ie schema: items: type: string type: array style: form - explode: true in: query name: rd__iew schema: items: type: string type: array style: form - explode: true in: query name: rd__ire schema: items: type: string type: array style: form - explode: true in: query name: rd__isw schema: items: type: string type: array style: form - explode: true in: query name: rd__n schema: items: type: string type: array style: form - explode: true in: query name: rd__nic schema: items: type: string type: array style: form - explode: true in: query name: rd__nie schema: items: type: string type: array style: form - explode: true in: query name: rd__niew schema: items: type: string type: array style: form - explode: true in: query name: rd__nire schema: items: type: string type: array style: form - explode: true in: query name: rd__nisw schema: items: type: string type: array style: form - explode: true in: query name: rd__nre schema: items: type: string type: array style: form - explode: true in: query name: rd__re schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVRFList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVRFRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VRF' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVRFRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VRF' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVRFRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VRF' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vrfs/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_destroy parameters: - description: A UUID string identifying this VRF. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - ipam get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_retrieve parameters: - description: A UUID string identifying this VRF. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VRF' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_partial_update parameters: - description: A UUID string identifying this VRF. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVRFRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VRF' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: ipam_vrfs_update parameters: - description: A UUID string identifying this VRF. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVRFRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VRF' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /ipam/vrfs/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: ipam_vrfs_notes_list parameters: - description: A UUID string identifying this VRF. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam post: description: API methods for returning or creating notes on an object. operationId: ipam_vrfs_notes_create parameters: - description: A UUID string identifying this VRF. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - ipam /plugins/bgp/address-families/: delete: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: List all objects of this type. operationId: plugins_bgp_address_families_list parameters: - explode: true in: query name: afi_safi schema: items: type: string type: array style: form - explode: true in: query name: afi_safi__n schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: BGP Routing Instance ID explode: true in: query name: routing_instance schema: items: format: uuid type: string type: array style: form - description: BGP Routing Instance ID explode: true in: query name: routing_instance__n schema: items: format: uuid type: string type: array style: form - description: VRF (name) explode: true in: query name: vrf schema: items: type: string type: array style: form - description: VRF (name) explode: true in: query name: vrf__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAddressFamilyList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableAddressFamilyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AddressFamily' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAddressFamilyRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressFamily' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableAddressFamilyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AddressFamily' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/address-families/{id}/: delete: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_destroy parameters: - description: A UUID string identifying this BGP address family. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Retrieve a specific object instance. operationId: plugins_bgp_address_families_retrieve parameters: - description: A UUID string identifying this BGP address family. in: path name: id required: true schema: format: uuid type: string - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressFamily' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_partial_update parameters: - description: A UUID string identifying this BGP address family. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableAddressFamilyRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressFamily' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for AddressFamily records. operationId: plugins_bgp_address_families_update parameters: - description: A UUID string identifying this BGP address family. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAddressFamilyRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressFamily' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/autonomous-systems/: delete: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_list parameters: - explode: true in: query name: asn schema: items: type: integer type: array style: form - explode: true in: query name: asn__gt schema: items: type: integer type: array style: form - explode: true in: query name: asn__gte schema: items: type: integer type: array style: form - explode: true in: query name: asn__lt schema: items: type: integer type: array style: form - explode: true in: query name: asn__lte schema: items: type: integer type: array style: form - explode: true in: query name: asn__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAutonomousSystemList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableAutonomousSystemRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AutonomousSystem' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAutonomousSystemRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AutonomousSystem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableAutonomousSystemRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AutonomousSystem' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/autonomous-systems/{id}/: delete: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_destroy parameters: - description: A UUID string identifying this Autonomous system. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_retrieve parameters: - description: A UUID string identifying this Autonomous system. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AutonomousSystem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_partial_update parameters: - description: A UUID string identifying this Autonomous system. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableAutonomousSystemRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AutonomousSystem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for AutonomousSystem records. operationId: plugins_bgp_autonomous_systems_update parameters: - description: A UUID string identifying this Autonomous system. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAutonomousSystemRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AutonomousSystem' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peer-endpoints/: delete: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: List all objects of this type. operationId: plugins_bgp_peer_endpoints_list parameters: - description: Autonomous System Number in: query name: autonomous_system required: false schema: type: string - description: Autonomous System Number in: query name: autonomous_system__n required: false schema: type: string - description: Device (name) in: query name: device required: false schema: type: string - description: Device (name) in: query name: device__n required: false schema: type: string - description: enabled in: query name: enabled required: false schema: type: string - description: id in: query name: id required: false schema: type: string - description: id__ic in: query name: id__ic required: false schema: type: string - description: id__ie in: query name: id__ie required: false schema: type: string - description: id__iew in: query name: id__iew required: false schema: type: string - description: id__ire in: query name: id__ire required: false schema: type: string - description: id__isw in: query name: id__isw required: false schema: type: string - description: id__n in: query name: id__n required: false schema: type: string - description: id__nic in: query name: id__nic required: false schema: type: string - description: id__nie in: query name: id__nie required: false schema: type: string - description: id__niew in: query name: id__niew required: false schema: type: string - description: id__nire in: query name: id__nire required: false schema: type: string - description: id__nisw in: query name: id__nisw required: false schema: type: string - description: id__nre in: query name: id__nre required: false schema: type: string - description: id__re in: query name: id__re required: false schema: type: string - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Peer Group (id) in: query name: peer_group required: false schema: type: string - description: Peer Group (id) in: query name: peer_group__n required: false schema: type: string - description: Search in: query name: q required: false schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPeerEndpointList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePeerEndpointRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeerEndpoint' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePeerEndpointRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerEndpoint' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePeerEndpointRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeerEndpoint' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peer-endpoints/{id}/: delete: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_destroy parameters: - description: A UUID string identifying this peer endpoint. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Retrieve a specific object instance. operationId: plugins_bgp_peer_endpoints_retrieve parameters: - description: A UUID string identifying this peer endpoint. in: path name: id required: true schema: format: uuid type: string - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerEndpoint' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_partial_update parameters: - description: A UUID string identifying this peer endpoint. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePeerEndpointRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerEndpoint' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeerEndpoint records. operationId: plugins_bgp_peer_endpoints_update parameters: - description: A UUID string identifying this peer endpoint. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePeerEndpointRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerEndpoint' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peer-group-templates/: delete: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: List all objects of this type. operationId: plugins_bgp_peer_group_templates_list parameters: - description: Autonomous System Number explode: true in: query name: autonomous_system schema: items: format: int64 maximum: 4294967295 minimum: 1 type: integer type: array style: form - description: Autonomous System Number explode: true in: query name: autonomous_system__n schema: items: format: int64 maximum: 4294967295 minimum: 1 type: integer type: array style: form - in: query name: enabled schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Peering role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Peering role (slug) explode: true in: query name: role__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPeerGroupTemplateList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePeerGroupTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeerGroupTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePeerGroupTemplateRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroupTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePeerGroupTemplateRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeerGroupTemplate' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peer-group-templates/{id}/: delete: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_destroy parameters: - description: A UUID string identifying this BGP Peer Group Template. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Retrieve a specific object instance. operationId: plugins_bgp_peer_group_templates_retrieve parameters: - description: A UUID string identifying this BGP Peer Group Template. in: path name: id required: true schema: format: uuid type: string - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroupTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_partial_update parameters: - description: A UUID string identifying this BGP Peer Group Template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePeerGroupTemplateRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroupTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeerGroupTemplate records. operationId: plugins_bgp_peer_group_templates_update parameters: - description: A UUID string identifying this BGP Peer Group Template. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePeerGroupTemplateRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroupTemplate' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peer-groups/: delete: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: List all objects of this type. operationId: plugins_bgp_peer_groups_list parameters: - description: Autonomous System Number in: query name: autonomous_system required: false schema: type: string - description: Autonomous System Number in: query name: autonomous_system__n required: false schema: type: string - description: enabled in: query name: enabled required: false schema: type: string - description: id in: query name: id required: false schema: type: string - description: id__ic in: query name: id__ic required: false schema: type: string - description: id__ie in: query name: id__ie required: false schema: type: string - description: id__iew in: query name: id__iew required: false schema: type: string - description: id__ire in: query name: id__ire required: false schema: type: string - description: id__isw in: query name: id__isw required: false schema: type: string - description: id__n in: query name: id__n required: false schema: type: string - description: id__nic in: query name: id__nic required: false schema: type: string - description: id__nie in: query name: id__nie required: false schema: type: string - description: id__niew in: query name: id__niew required: false schema: type: string - description: id__nire in: query name: id__nire required: false schema: type: string - description: id__nisw in: query name: id__nisw required: false schema: type: string - description: id__nre in: query name: id__nre required: false schema: type: string - description: id__re in: query name: id__re required: false schema: type: string - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: name in: query name: name required: false schema: type: string - description: name__ic in: query name: name__ic required: false schema: type: string - description: name__ie in: query name: name__ie required: false schema: type: string - description: name__iew in: query name: name__iew required: false schema: type: string - description: name__ire in: query name: name__ire required: false schema: type: string - description: name__isw in: query name: name__isw required: false schema: type: string - description: name__n in: query name: name__n required: false schema: type: string - description: name__nic in: query name: name__nic required: false schema: type: string - description: name__nie in: query name: name__nie required: false schema: type: string - description: name__niew in: query name: name__niew required: false schema: type: string - description: name__nire in: query name: name__nire required: false schema: type: string - description: name__nisw in: query name: name__nisw required: false schema: type: string - description: name__nre in: query name: name__nre required: false schema: type: string - description: name__re in: query name: name__re required: false schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q required: false schema: type: string - description: Peering role (slug) in: query name: role required: false schema: type: string - description: Peering role (slug) in: query name: role__n required: false schema: type: string - description: BGP Routing Instance ID in: query name: routing_instance required: false schema: type: string - description: BGP Routing Instance ID in: query name: routing_instance__n required: false schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPeerGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePeerGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeerGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePeerGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePeerGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeerGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peer-groups/{id}/: delete: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_destroy parameters: - description: A UUID string identifying this BGP Peer Group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Retrieve a specific object instance. operationId: plugins_bgp_peer_groups_retrieve parameters: - description: A UUID string identifying this BGP Peer Group. in: path name: id required: true schema: format: uuid type: string - description: Include inherited configuration values in: query name: include_inherited schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_partial_update parameters: - description: A UUID string identifying this BGP Peer Group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePeerGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeerGroup records. operationId: plugins_bgp_peer_groups_update parameters: - description: A UUID string identifying this BGP Peer Group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePeerGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeerGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peering-roles/: delete: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_list parameters: - explode: true in: query name: color schema: items: type: string type: array style: form - explode: true in: query name: color__ic schema: items: type: string type: array style: form - explode: true in: query name: color__ie schema: items: type: string type: array style: form - explode: true in: query name: color__iew schema: items: type: string type: array style: form - explode: true in: query name: color__ire schema: items: type: string type: array style: form - explode: true in: query name: color__isw schema: items: type: string type: array style: form - explode: true in: query name: color__n schema: items: type: string type: array style: form - explode: true in: query name: color__nic schema: items: type: string type: array style: form - explode: true in: query name: color__nie schema: items: type: string type: array style: form - explode: true in: query name: color__niew schema: items: type: string type: array style: form - explode: true in: query name: color__nire schema: items: type: string type: array style: form - explode: true in: query name: color__nisw schema: items: type: string type: array style: form - explode: true in: query name: color__nre schema: items: type: string type: array style: form - explode: true in: query name: color__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPeeringRoleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePeeringRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeeringRole' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_create requestBody: content: application/json: schema: $ref: '#/components/schemas/PeeringRoleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeeringRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePeeringRoleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PeeringRole' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peering-roles/{id}/: delete: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_destroy parameters: - description: A UUID string identifying this BGP Peering Role. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_retrieve parameters: - description: A UUID string identifying this BGP Peering Role. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeeringRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_partial_update parameters: - description: A UUID string identifying this BGP Peering Role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPeeringRoleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeeringRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for PeeringRole records. operationId: plugins_bgp_peering_roles_update parameters: - description: A UUID string identifying this BGP Peering Role. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PeeringRoleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PeeringRole' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peerings/: delete: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPeeringList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePeeringRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Peering' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_create requestBody: content: application/json: schema: $ref: '#/components/schemas/PeeringRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Peering' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePeeringRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Peering' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/peerings/{id}/: delete: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_destroy parameters: - description: A UUID string identifying this BGP Peering. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_retrieve parameters: - description: A UUID string identifying this BGP Peering. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Peering' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_partial_update parameters: - description: A UUID string identifying this BGP Peering. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPeeringRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Peering' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for Peering records. operationId: plugins_bgp_peerings_update parameters: - description: A UUID string identifying this BGP Peering. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PeeringRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Peering' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/routing-instances/: delete: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_list parameters: - description: Autonomous System Number explode: true in: query name: autonomous_system schema: items: format: int64 maximum: 4294967295 minimum: 1 type: integer type: array style: form - description: Autonomous System Number explode: true in: query name: autonomous_system__n schema: items: format: int64 maximum: 4294967295 minimum: 1 type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device (name) explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device (name) explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device (ID) explode: true in: query name: device_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedBGPRoutingInstanceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableBGPRoutingInstanceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/BGPRoutingInstance' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableBGPRoutingInstanceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/BGPRoutingInstance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableBGPRoutingInstanceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/BGPRoutingInstance' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/bgp/routing-instances/{id}/: delete: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_destroy parameters: - description: A UUID string identifying this BGP Routing Instance. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_retrieve parameters: - description: A UUID string identifying this BGP Routing Instance. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/BGPRoutingInstance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_partial_update parameters: - description: A UUID string identifying this BGP Routing Instance. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableBGPRoutingInstanceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/BGPRoutingInstance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for BGPRoutingInstance records. operationId: plugins_bgp_routing_instances_update parameters: - description: A UUID string identifying this BGP Routing Instance. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableBGPRoutingInstanceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/BGPRoutingInstance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/chatops/accessgrant/: delete: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_list parameters: - explode: true in: query name: command schema: items: type: string type: array style: form - explode: true in: query name: command__ic schema: items: type: string type: array style: form - explode: true in: query name: command__ie schema: items: type: string type: array style: form - explode: true in: query name: command__iew schema: items: type: string type: array style: form - explode: true in: query name: command__ire schema: items: type: string type: array style: form - explode: true in: query name: command__isw schema: items: type: string type: array style: form - explode: true in: query name: command__n schema: items: type: string type: array style: form - explode: true in: query name: command__nic schema: items: type: string type: array style: form - explode: true in: query name: command__nie schema: items: type: string type: array style: form - explode: true in: query name: command__niew schema: items: type: string type: array style: form - explode: true in: query name: command__nire schema: items: type: string type: array style: form - explode: true in: query name: command__nisw schema: items: type: string type: array style: form - explode: true in: query name: command__nre schema: items: type: string type: array style: form - explode: true in: query name: command__re schema: items: type: string type: array style: form - in: query name: grant_type schema: type: string - in: query name: grant_type__n schema: type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: subcommand schema: items: type: string type: array style: form - explode: true in: query name: subcommand__ic schema: items: type: string type: array style: form - explode: true in: query name: subcommand__ie schema: items: type: string type: array style: form - explode: true in: query name: subcommand__iew schema: items: type: string type: array style: form - explode: true in: query name: subcommand__ire schema: items: type: string type: array style: form - explode: true in: query name: subcommand__isw schema: items: type: string type: array style: form - explode: true in: query name: subcommand__n schema: items: type: string type: array style: form - explode: true in: query name: subcommand__nic schema: items: type: string type: array style: form - explode: true in: query name: subcommand__nie schema: items: type: string type: array style: form - explode: true in: query name: subcommand__niew schema: items: type: string type: array style: form - explode: true in: query name: subcommand__nire schema: items: type: string type: array style: form - explode: true in: query name: subcommand__nisw schema: items: type: string type: array style: form - explode: true in: query name: subcommand__nre schema: items: type: string type: array style: form - explode: true in: query name: subcommand__re schema: items: type: string type: array style: form - explode: true in: query name: value schema: items: type: string type: array style: form - explode: true in: query name: value__ic schema: items: type: string type: array style: form - explode: true in: query name: value__ie schema: items: type: string type: array style: form - explode: true in: query name: value__iew schema: items: type: string type: array style: form - explode: true in: query name: value__ire schema: items: type: string type: array style: form - explode: true in: query name: value__isw schema: items: type: string type: array style: form - explode: true in: query name: value__n schema: items: type: string type: array style: form - explode: true in: query name: value__nic schema: items: type: string type: array style: form - explode: true in: query name: value__nie schema: items: type: string type: array style: form - explode: true in: query name: value__niew schema: items: type: string type: array style: form - explode: true in: query name: value__nire schema: items: type: string type: array style: form - explode: true in: query name: value__nisw schema: items: type: string type: array style: form - explode: true in: query name: value__nre schema: items: type: string type: array style: form - explode: true in: query name: value__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAccessGrantList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableAccessGrantRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AccessGrant' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_create requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessGrantRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AccessGrant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableAccessGrantRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AccessGrant' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/chatops/accessgrant/{id}/: delete: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_destroy parameters: - description: A UUID string identifying this access grant. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_retrieve parameters: - description: A UUID string identifying this access grant. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AccessGrant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_partial_update parameters: - description: A UUID string identifying this access grant. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedAccessGrantRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AccessGrant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with AccessGrant objects. operationId: plugins_chatops_accessgrant_update parameters: - description: A UUID string identifying this access grant. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessGrantRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AccessGrant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/chatops/commandtoken/: delete: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_list parameters: - explode: true in: query name: comment schema: items: type: string type: array style: form - explode: true in: query name: comment__ic schema: items: type: string type: array style: form - explode: true in: query name: comment__ie schema: items: type: string type: array style: form - explode: true in: query name: comment__iew schema: items: type: string type: array style: form - explode: true in: query name: comment__ire schema: items: type: string type: array style: form - explode: true in: query name: comment__isw schema: items: type: string type: array style: form - explode: true in: query name: comment__n schema: items: type: string type: array style: form - explode: true in: query name: comment__nic schema: items: type: string type: array style: form - explode: true in: query name: comment__nie schema: items: type: string type: array style: form - explode: true in: query name: comment__niew schema: items: type: string type: array style: form - explode: true in: query name: comment__nire schema: items: type: string type: array style: form - explode: true in: query name: comment__nisw schema: items: type: string type: array style: form - explode: true in: query name: comment__nre schema: items: type: string type: array style: form - explode: true in: query name: comment__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: platform schema: type: string - in: query name: platform__n schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCommandTokenList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCommandTokenRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CommandToken' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CommandTokenRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CommandToken' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCommandTokenRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CommandToken' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/chatops/commandtoken/{id}/: delete: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_destroy parameters: - description: A UUID string identifying this command token. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_retrieve parameters: - description: A UUID string identifying this command token. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CommandToken' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_partial_update parameters: - description: A UUID string identifying this command token. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCommandTokenRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CommandToken' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with CommandToken objects. operationId: plugins_chatops_commandtoken_update parameters: - description: A UUID string identifying this command token. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CommandTokenRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CommandToken' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/circuitimpact/: delete: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_list parameters: - in: query name: circuit schema: format: uuid type: string - in: query name: circuit__n schema: format: uuid type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: impact schema: nullable: true type: string - in: query name: impact__n schema: nullable: true type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: maintenance schema: format: uuid type: string - in: query name: maintenance__n schema: format: uuid type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCircuitMaintenanceCircuitImpactList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCircuitMaintenanceCircuitImpactRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpactRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCircuitMaintenanceCircuitImpactRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/circuitimpact/{id}/: delete: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_destroy parameters: - description: A UUID string identifying this circuit impact. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_retrieve parameters: - description: A UUID string identifying this circuit impact. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_partial_update parameters: - description: A UUID string identifying this circuit impact. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCircuitMaintenanceCircuitImpactRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API view for Circuit Impact CRUD operations. operationId: plugins_circuit_maintenance_circuitimpact_update parameters: - description: A UUID string identifying this circuit impact. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpactRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenanceCircuitImpact' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/maintenance/: delete: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_list parameters: - in: query name: ack schema: type: boolean - description: Circuit explode: true in: query name: circuit schema: items: type: string type: array style: form - in: query name: end_time schema: format: date-time type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Provider (slug) explode: true in: query name: provider schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - in: query name: start_time schema: format: date-time type: string - in: query name: status schema: nullable: true type: string - in: query name: status__n schema: nullable: true type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCircuitMaintenanceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCircuitMaintenanceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitMaintenance' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitMaintenanceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCircuitMaintenanceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CircuitMaintenance' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/maintenance/{id}/: delete: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_destroy parameters: - description: A UUID string identifying this circuit maintenance. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_retrieve parameters: - description: A UUID string identifying this circuit maintenance. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_partial_update parameters: - description: A UUID string identifying this circuit maintenance. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCircuitMaintenanceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API view for Circuit Maintenance CRUD operations. operationId: plugins_circuit_maintenance_maintenance_update parameters: - description: A UUID string identifying this circuit maintenance. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CircuitMaintenanceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CircuitMaintenance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/note/: delete: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_list parameters: - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableNoteRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Note' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_create requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableNoteRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Note' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/note/{id}/: delete: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_destroy parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_retrieve parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_partial_update parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedNoteRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API view for Circuit Note CRUD operations. operationId: plugins_circuit_maintenance_note_update parameters: - description: A UUID string identifying this note. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/notificationsource/: get: description: API view for Notification Source CRUD operations. operationId: plugins_circuit_maintenance_notificationsource_list parameters: - in: query name: attach_all_providers schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNotificationSourceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/circuit-maintenance/notificationsource/{id}/: get: description: API view for Notification Source CRUD operations. operationId: plugins_circuit_maintenance_notificationsource_retrieve parameters: - description: A UUID string identifying this notification source. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NotificationSource' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/data-validation-engine/rules/min-max/: delete: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_list parameters: - explode: true in: query name: content_type schema: items: type: integer type: array style: form - explode: true in: query name: content_type__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: enabled schema: type: boolean - explode: true in: query name: error_message schema: items: type: string type: array style: form - explode: true in: query name: error_message__ic schema: items: type: string type: array style: form - explode: true in: query name: error_message__ie schema: items: type: string type: array style: form - explode: true in: query name: error_message__iew schema: items: type: string type: array style: form - explode: true in: query name: error_message__ire schema: items: type: string type: array style: form - explode: true in: query name: error_message__isw schema: items: type: string type: array style: form - explode: true in: query name: error_message__n schema: items: type: string type: array style: form - explode: true in: query name: error_message__nic schema: items: type: string type: array style: form - explode: true in: query name: error_message__nie schema: items: type: string type: array style: form - explode: true in: query name: error_message__niew schema: items: type: string type: array style: form - explode: true in: query name: error_message__nire schema: items: type: string type: array style: form - explode: true in: query name: error_message__nisw schema: items: type: string type: array style: form - explode: true in: query name: error_message__nre schema: items: type: string type: array style: form - explode: true in: query name: error_message__re schema: items: type: string type: array style: form - explode: true in: query name: field schema: items: type: string type: array style: form - explode: true in: query name: field__ic schema: items: type: string type: array style: form - explode: true in: query name: field__ie schema: items: type: string type: array style: form - explode: true in: query name: field__iew schema: items: type: string type: array style: form - explode: true in: query name: field__ire schema: items: type: string type: array style: form - explode: true in: query name: field__isw schema: items: type: string type: array style: form - explode: true in: query name: field__n schema: items: type: string type: array style: form - explode: true in: query name: field__nic schema: items: type: string type: array style: form - explode: true in: query name: field__nie schema: items: type: string type: array style: form - explode: true in: query name: field__niew schema: items: type: string type: array style: form - explode: true in: query name: field__nire schema: items: type: string type: array style: form - explode: true in: query name: field__nisw schema: items: type: string type: array style: form - explode: true in: query name: field__nre schema: items: type: string type: array style: form - explode: true in: query name: field__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: max schema: items: format: float type: number type: array style: form - explode: true in: query name: max__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: max__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: max__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: max__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: max__n schema: items: format: float type: number type: array style: form - explode: true in: query name: min schema: items: format: float type: number type: array style: form - explode: true in: query name: min__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: min__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: min__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: min__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: min__n schema: items: format: float type: number type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedMinMaxValidationRuleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableMinMaxValidationRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/MinMaxValidationRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_create requestBody: content: application/json: schema: $ref: '#/components/schemas/MinMaxValidationRuleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/MinMaxValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableMinMaxValidationRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/MinMaxValidationRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/data-validation-engine/rules/min-max/{id}/: delete: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_destroy parameters: - description: A UUID string identifying this min max validation rule. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_retrieve parameters: - description: A UUID string identifying this min max validation rule. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/MinMaxValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_partial_update parameters: - description: A UUID string identifying this min max validation rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedMinMaxValidationRuleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/MinMaxValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: View to manage min max expression validation rules operationId: plugins_data_validation_engine_rules_min_max_update parameters: - description: A UUID string identifying this min max validation rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MinMaxValidationRuleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/MinMaxValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/data-validation-engine/rules/regex/: delete: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_list parameters: - explode: true in: query name: content_type schema: items: type: integer type: array style: form - explode: true in: query name: content_type__n schema: items: type: integer type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: enabled schema: type: boolean - explode: true in: query name: error_message schema: items: type: string type: array style: form - explode: true in: query name: error_message__ic schema: items: type: string type: array style: form - explode: true in: query name: error_message__ie schema: items: type: string type: array style: form - explode: true in: query name: error_message__iew schema: items: type: string type: array style: form - explode: true in: query name: error_message__ire schema: items: type: string type: array style: form - explode: true in: query name: error_message__isw schema: items: type: string type: array style: form - explode: true in: query name: error_message__n schema: items: type: string type: array style: form - explode: true in: query name: error_message__nic schema: items: type: string type: array style: form - explode: true in: query name: error_message__nie schema: items: type: string type: array style: form - explode: true in: query name: error_message__niew schema: items: type: string type: array style: form - explode: true in: query name: error_message__nire schema: items: type: string type: array style: form - explode: true in: query name: error_message__nisw schema: items: type: string type: array style: form - explode: true in: query name: error_message__nre schema: items: type: string type: array style: form - explode: true in: query name: error_message__re schema: items: type: string type: array style: form - explode: true in: query name: field schema: items: type: string type: array style: form - explode: true in: query name: field__ic schema: items: type: string type: array style: form - explode: true in: query name: field__ie schema: items: type: string type: array style: form - explode: true in: query name: field__iew schema: items: type: string type: array style: form - explode: true in: query name: field__ire schema: items: type: string type: array style: form - explode: true in: query name: field__isw schema: items: type: string type: array style: form - explode: true in: query name: field__n schema: items: type: string type: array style: form - explode: true in: query name: field__nic schema: items: type: string type: array style: form - explode: true in: query name: field__nie schema: items: type: string type: array style: form - explode: true in: query name: field__niew schema: items: type: string type: array style: form - explode: true in: query name: field__nire schema: items: type: string type: array style: form - explode: true in: query name: field__nisw schema: items: type: string type: array style: form - explode: true in: query name: field__nre schema: items: type: string type: array style: form - explode: true in: query name: field__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: regular_expression schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__ic schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__ie schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__iew schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__ire schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__isw schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__n schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__nic schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__nie schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__niew schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__nire schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__nisw schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__nre schema: items: type: string type: array style: form - explode: true in: query name: regular_expression__re schema: items: type: string type: array style: form - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedRegularExpressionValidationRuleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableRegularExpressionValidationRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RegularExpressionValidationRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_create requestBody: content: application/json: schema: $ref: '#/components/schemas/RegularExpressionValidationRuleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RegularExpressionValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableRegularExpressionValidationRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/RegularExpressionValidationRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/data-validation-engine/rules/regex/{id}/: delete: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_destroy parameters: - description: A UUID string identifying this regular expression validation rule. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_retrieve parameters: - description: A UUID string identifying this regular expression validation rule. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RegularExpressionValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_partial_update parameters: - description: A UUID string identifying this regular expression validation rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRegularExpressionValidationRuleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RegularExpressionValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: View to manage regular expression validation rules operationId: plugins_data_validation_engine_rules_regex_update parameters: - description: A UUID string identifying this regular expression validation rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RegularExpressionValidationRuleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/RegularExpressionValidationRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/device-onboarding/onboarding/: get: description: 'Create, check status of, and delete onboarding tasks. In-place updates (PUT, PATCH) of tasks are not permitted.' operationId: plugins_device_onboarding_onboarding_list parameters: - description: Raison why the task failed (optional) in: query name: failed_reason schema: nullable: true type: string - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Device Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Site (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Overall status of the task in: query name: status schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedOnboardingTaskList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: 'Create, check status of, and delete onboarding tasks. In-place updates (PUT, PATCH) of tasks are not permitted.' operationId: plugins_device_onboarding_onboarding_create requestBody: content: application/json: schema: $ref: '#/components/schemas/OnboardingTaskRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/OnboardingTask' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/device-onboarding/onboarding/{id}/: delete: description: 'Create, check status of, and delete onboarding tasks. In-place updates (PUT, PATCH) of tasks are not permitted.' operationId: plugins_device_onboarding_onboarding_destroy parameters: - description: A UUID string identifying this onboarding task. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: 'Create, check status of, and delete onboarding tasks. In-place updates (PUT, PATCH) of tasks are not permitted.' operationId: plugins_device_onboarding_onboarding_retrieve parameters: - description: A UUID string identifying this onboarding task. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/OnboardingTask' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/address-object-group/: delete: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_list parameters: - explode: true in: query name: address_objects schema: items: format: uuid type: string type: array style: form - explode: true in: query name: address_objects__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAddressObjectGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableAddressObjectGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AddressObjectGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAddressObjectGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableAddressObjectGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AddressObjectGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/address-object-group/{id}/: delete: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_destroy parameters: - description: A UUID string identifying this address object group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_retrieve parameters: - description: A UUID string identifying this address object group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_partial_update parameters: - description: A UUID string identifying this address object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableAddressObjectGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: AddressObjectGroup viewset. operationId: plugins_firewall_address_object_group_update parameters: - description: A UUID string identifying this address object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAddressObjectGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/address-object-group/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_address_object_group_notes_list parameters: - description: A UUID string identifying this address object group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_address_object_group_notes_create parameters: - description: A UUID string identifying this address object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/address-object/: delete: description: AddressObject viewset. operationId: plugins_firewall_address_object_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: AddressObject viewset. operationId: plugins_firewall_address_object_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - in: query name: fqdn schema: format: uuid type: string - in: query name: fqdn__n schema: format: uuid type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: ip_address schema: format: uuid type: string - in: query name: ip_address__n schema: format: uuid type: string - in: query name: ip_range schema: format: uuid type: string - in: query name: ip_range__n schema: format: uuid type: string - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: prefix schema: format: uuid type: string - in: query name: prefix__n schema: format: uuid type: string - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedAddressObjectList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: AddressObject viewset. operationId: plugins_firewall_address_object_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableAddressObjectRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AddressObject' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: AddressObject viewset. operationId: plugins_firewall_address_object_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAddressObjectRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: AddressObject viewset. operationId: plugins_firewall_address_object_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableAddressObjectRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/AddressObject' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/address-object/{id}/: delete: description: AddressObject viewset. operationId: plugins_firewall_address_object_destroy parameters: - description: A UUID string identifying this address object. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: AddressObject viewset. operationId: plugins_firewall_address_object_retrieve parameters: - description: A UUID string identifying this address object. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: AddressObject viewset. operationId: plugins_firewall_address_object_partial_update parameters: - description: A UUID string identifying this address object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableAddressObjectRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: AddressObject viewset. operationId: plugins_firewall_address_object_update parameters: - description: A UUID string identifying this address object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAddressObjectRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/AddressObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/address-object/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_address_object_notes_list parameters: - description: A UUID string identifying this address object. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_address_object_notes_create parameters: - description: A UUID string identifying this address object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/capirca-policy/: delete: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device Name explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device Name explode: true in: query name: device__n schema: items: nullable: true type: string type: array style: form - description: Device ID explode: true in: query name: device_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Device ID explode: true in: query name: device_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCapircaPolicyList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCapircaPolicyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CapircaPolicy' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_create requestBody: content: application/json: schema: $ref: '#/components/schemas/CapircaPolicyRequest' responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CapircaPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCapircaPolicyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CapircaPolicy' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/capirca-policy/{id}/: delete: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_destroy parameters: - description: A UUID string identifying this capirca policy. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_retrieve parameters: - description: A UUID string identifying this capirca policy. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CapircaPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_partial_update parameters: - description: A UUID string identifying this capirca policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedCapircaPolicyRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CapircaPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CapircaPolicy viewset. operationId: plugins_firewall_capirca_policy_update parameters: - description: A UUID string identifying this capirca policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapircaPolicyRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CapircaPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/fqdn/: delete: description: FQDN viewset. operationId: plugins_firewall_fqdn_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: FQDN viewset. operationId: plugins_firewall_fqdn_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedFQDNList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: FQDN viewset. operationId: plugins_firewall_fqdn_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableFQDNRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/FQDN' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: FQDN viewset. operationId: plugins_firewall_fqdn_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFQDNRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FQDN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: FQDN viewset. operationId: plugins_firewall_fqdn_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableFQDNRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/FQDN' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/fqdn/{id}/: delete: description: FQDN viewset. operationId: plugins_firewall_fqdn_destroy parameters: - description: A UUID string identifying this FQDN. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: FQDN viewset. operationId: plugins_firewall_fqdn_retrieve parameters: - description: A UUID string identifying this FQDN. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FQDN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: FQDN viewset. operationId: plugins_firewall_fqdn_partial_update parameters: - description: A UUID string identifying this FQDN. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableFQDNRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FQDN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: FQDN viewset. operationId: plugins_firewall_fqdn_update parameters: - description: A UUID string identifying this FQDN. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableFQDNRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/FQDN' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/fqdn/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_fqdn_notes_list parameters: - description: A UUID string identifying this FQDN. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_fqdn_notes_create parameters: - description: A UUID string identifying this FQDN. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/ip-range/: delete: description: IPRange viewset. operationId: plugins_firewall_ip_range_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: IPRange viewset. operationId: plugins_firewall_ip_range_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: size schema: items: type: integer type: array style: form - explode: true in: query name: size__gt schema: items: type: integer type: array style: form - explode: true in: query name: size__gte schema: items: type: integer type: array style: form - explode: true in: query name: size__lt schema: items: type: integer type: array style: form - explode: true in: query name: size__lte schema: items: type: integer type: array style: form - explode: true in: query name: size__n schema: items: type: integer type: array style: form - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - in: query name: vrf schema: format: uuid type: string - in: query name: vrf__n schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedIPRangeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: IPRange viewset. operationId: plugins_firewall_ip_range_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableIPRangeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/IPRange' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: IPRange viewset. operationId: plugins_firewall_ip_range_create requestBody: content: application/json: schema: $ref: '#/components/schemas/IPRangeRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPRange' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: IPRange viewset. operationId: plugins_firewall_ip_range_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableIPRangeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/IPRange' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/ip-range/{id}/: delete: description: IPRange viewset. operationId: plugins_firewall_ip_range_destroy parameters: - description: A UUID string identifying this ip range. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: IPRange viewset. operationId: plugins_firewall_ip_range_retrieve parameters: - description: A UUID string identifying this ip range. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPRange' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: IPRange viewset. operationId: plugins_firewall_ip_range_partial_update parameters: - description: A UUID string identifying this ip range. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedIPRangeRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPRange' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: IPRange viewset. operationId: plugins_firewall_ip_range_update parameters: - description: A UUID string identifying this ip range. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/IPRangeRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/IPRange' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/ip-range/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_ip_range_notes_list parameters: - description: A UUID string identifying this ip range. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_ip_range_notes_create parameters: - description: A UUID string identifying this ip range. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/nat-policy-rule/: delete: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: log schema: type: boolean - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: remark schema: type: boolean - explode: true in: query name: request_id schema: items: type: string type: array style: form - explode: true in: query name: request_id__ic schema: items: type: string type: array style: form - explode: true in: query name: request_id__ie schema: items: type: string type: array style: form - explode: true in: query name: request_id__iew schema: items: type: string type: array style: form - explode: true in: query name: request_id__ire schema: items: type: string type: array style: form - explode: true in: query name: request_id__isw schema: items: type: string type: array style: form - explode: true in: query name: request_id__n schema: items: type: string type: array style: form - explode: true in: query name: request_id__nic schema: items: type: string type: array style: form - explode: true in: query name: request_id__nie schema: items: type: string type: array style: form - explode: true in: query name: request_id__niew schema: items: type: string type: array style: form - explode: true in: query name: request_id__nire schema: items: type: string type: array style: form - explode: true in: query name: request_id__nisw schema: items: type: string type: array style: form - explode: true in: query name: request_id__nre schema: items: type: string type: array style: form - explode: true in: query name: request_id__re schema: items: type: string type: array style: form - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNATPolicyRuleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableNATPolicyRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/NATPolicyRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableNATPolicyRuleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableNATPolicyRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/NATPolicyRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/nat-policy-rule/{id}/: delete: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_destroy parameters: - description: A UUID string identifying this nat policy rule. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_retrieve parameters: - description: A UUID string identifying this nat policy rule. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_partial_update parameters: - description: A UUID string identifying this nat policy rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableNATPolicyRuleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: NATPolicyRule viewset. operationId: plugins_firewall_nat_policy_rule_update parameters: - description: A UUID string identifying this nat policy rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableNATPolicyRuleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/nat-policy-rule/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_nat_policy_rule_notes_list parameters: - description: A UUID string identifying this nat policy rule. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_nat_policy_rule_notes_create parameters: - description: A UUID string identifying this nat policy rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/nat-policy/: delete: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_list parameters: - explode: true in: query name: assigned_devices schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_devices__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_dynamic_groups schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_dynamic_groups__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - explode: true in: query name: nat_policy_rules schema: items: format: uuid type: string type: array style: form - explode: true in: query name: nat_policy_rules__n schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNATPolicyList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableNATPolicyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/NATPolicy' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_create requestBody: content: application/json: schema: $ref: '#/components/schemas/NATPolicyRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableNATPolicyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/NATPolicy' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/nat-policy/{id}/: delete: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_destroy parameters: - description: A UUID string identifying this nat policy. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_retrieve parameters: - description: A UUID string identifying this nat policy. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_partial_update parameters: - description: A UUID string identifying this nat policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedNATPolicyRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: NATPolicy viewset. operationId: plugins_firewall_nat_policy_update parameters: - description: A UUID string identifying this nat policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NATPolicyRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/NATPolicy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/nat-policy/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_nat_policy_notes_list parameters: - description: A UUID string identifying this nat policy. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_nat_policy_notes_create parameters: - description: A UUID string identifying this nat policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/policy-rule/: delete: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_list parameters: - in: query name: action schema: enum: - allow - deny - drop - remark type: string - in: query name: action__n schema: enum: - allow - deny - drop - remark type: string - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: log schema: type: boolean - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: request_id schema: items: type: string type: array style: form - explode: true in: query name: request_id__ic schema: items: type: string type: array style: form - explode: true in: query name: request_id__ie schema: items: type: string type: array style: form - explode: true in: query name: request_id__iew schema: items: type: string type: array style: form - explode: true in: query name: request_id__ire schema: items: type: string type: array style: form - explode: true in: query name: request_id__isw schema: items: type: string type: array style: form - explode: true in: query name: request_id__n schema: items: type: string type: array style: form - explode: true in: query name: request_id__nic schema: items: type: string type: array style: form - explode: true in: query name: request_id__nie schema: items: type: string type: array style: form - explode: true in: query name: request_id__niew schema: items: type: string type: array style: form - explode: true in: query name: request_id__nire schema: items: type: string type: array style: form - explode: true in: query name: request_id__nisw schema: items: type: string type: array style: form - explode: true in: query name: request_id__nre schema: items: type: string type: array style: form - explode: true in: query name: request_id__re schema: items: type: string type: array style: form - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPolicyRuleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePolicyRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PolicyRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePolicyRuleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePolicyRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/PolicyRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/policy-rule/{id}/: delete: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_destroy parameters: - description: A UUID string identifying this policy rule. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_retrieve parameters: - description: A UUID string identifying this policy rule. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_partial_update parameters: - description: A UUID string identifying this policy rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePolicyRuleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: PolicyRule viewset. operationId: plugins_firewall_policy_rule_update parameters: - description: A UUID string identifying this policy rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePolicyRuleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PolicyRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/policy-rule/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_policy_rule_notes_list parameters: - description: A UUID string identifying this policy rule. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_policy_rule_notes_create parameters: - description: A UUID string identifying this policy rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/policy/: delete: description: Policy viewset. operationId: plugins_firewall_policy_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Policy viewset. operationId: plugins_firewall_policy_list parameters: - explode: true in: query name: assigned_devices schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_devices__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_dynamic_groups schema: items: format: uuid type: string type: array style: form - explode: true in: query name: assigned_dynamic_groups__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: policy_rules schema: items: format: uuid type: string type: array style: form - explode: true in: query name: policy_rules__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedPolicyList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: Policy viewset. operationId: plugins_firewall_policy_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritablePolicyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Policy' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: Policy viewset. operationId: plugins_firewall_policy_create requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Policy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: Policy viewset. operationId: plugins_firewall_policy_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritablePolicyRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Policy' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/policy/{id}/: delete: description: Policy viewset. operationId: plugins_firewall_policy_destroy parameters: - description: A UUID string identifying this policy. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Policy viewset. operationId: plugins_firewall_policy_retrieve parameters: - description: A UUID string identifying this policy. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Policy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: Policy viewset. operationId: plugins_firewall_policy_partial_update parameters: - description: A UUID string identifying this policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPolicyRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Policy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: Policy viewset. operationId: plugins_firewall_policy_update parameters: - description: A UUID string identifying this policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Policy' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/policy/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_policy_notes_list parameters: - description: A UUID string identifying this policy. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_policy_notes_create parameters: - description: A UUID string identifying this policy. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/service-object-group/: delete: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: service_objects schema: items: format: uuid type: string type: array style: form - explode: true in: query name: service_objects__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedServiceObjectGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableServiceObjectGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ServiceObjectGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableServiceObjectGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableServiceObjectGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ServiceObjectGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/service-object-group/{id}/: delete: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_destroy parameters: - description: A UUID string identifying this service object group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_retrieve parameters: - description: A UUID string identifying this service object group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_partial_update parameters: - description: A UUID string identifying this service object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableServiceObjectGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: ServiceObjectGroup viewset. operationId: plugins_firewall_service_object_group_update parameters: - description: A UUID string identifying this service object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableServiceObjectGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/service-object-group/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_service_object_group_notes_list parameters: - description: A UUID string identifying this service object group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_service_object_group_notes_create parameters: - description: A UUID string identifying this service object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/service-object/: delete: description: ServiceObject viewset. operationId: plugins_firewall_service_object_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: ServiceObject viewset. operationId: plugins_firewall_service_object_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: IANA IP Protocol (e.g. TCP UDP ICMP) in: query name: ip_protocol schema: enum: - 3PC - A/N - AH - ARIS - AX.25 - BBN-RCC-MON - BNA - BR-SAT-MON - CBT - CFTP - CHAOS - CPHB - CPNX - CRTP - CRUDP - Compaq-Peer - DCCP - DCN-MEAS - DDP - DDX - DGP - DSR - EGP - EIGRP - EMCON - ENCAP - ESP - ETHERIP - Ethernet - FC - FIRE - GGP - GMTP - GRE - HIP - HMP - I-NLSP - IATP - ICMP - IDPR - IDPR-CMTP - IDRP - IFMP - IGMP - IGP - IL - IPCV - IPComp - IPIP - IPLT - IPPC - IPX-in-IP - IRTP - ISO-IP - ISO-TP4 - KRYPTOLAN - L2TP - LARP - LEAF-1 - LEAF-2 - MERIT-INP - MFE-NSP - MOBILE - MTP - MUX - NARP - NETBLT - NSFNET-IGP - NVP-II - OSPFIGP - PGM - PIM - PIPE - PNNI - PRM - PTP - PUP - PVP - QNX - RDP - ROHC - RSVP - RSVP-E2E-IGNORE - RVD - SAT-EXPAK - SAT-MON - SCC-SP - SCPS - SCTP - SDRP - SECURE-VMTP - SKIP - SM - SMP - SNP - SPS - SRP - SSCOPMCE - STP - SUN-ND - Sprite-RPC - TCF - TCP - TLSP - TP++ - TRUNK-1 - TRUNK-2 - TTP - UDP - UDPLite - UTI - VINES - VISA - VMTP - WB-EXPAK - WB-MON - WESP - WSN - XNET - XNS-IDP - XTP - manet type: string - description: IANA IP Protocol (e.g. TCP UDP ICMP) in: query name: ip_protocol__n schema: enum: - 3PC - A/N - AH - ARIS - AX.25 - BBN-RCC-MON - BNA - BR-SAT-MON - CBT - CFTP - CHAOS - CPHB - CPNX - CRTP - CRUDP - Compaq-Peer - DCCP - DCN-MEAS - DDP - DDX - DGP - DSR - EGP - EIGRP - EMCON - ENCAP - ESP - ETHERIP - Ethernet - FC - FIRE - GGP - GMTP - GRE - HIP - HMP - I-NLSP - IATP - ICMP - IDPR - IDPR-CMTP - IDRP - IFMP - IGMP - IGP - IL - IPCV - IPComp - IPIP - IPLT - IPPC - IPX-in-IP - IRTP - ISO-IP - ISO-TP4 - KRYPTOLAN - L2TP - LARP - LEAF-1 - LEAF-2 - MERIT-INP - MFE-NSP - MOBILE - MTP - MUX - NARP - NETBLT - NSFNET-IGP - NVP-II - OSPFIGP - PGM - PIM - PIPE - PNNI - PRM - PTP - PUP - PVP - QNX - RDP - ROHC - RSVP - RSVP-E2E-IGNORE - RVD - SAT-EXPAK - SAT-MON - SCC-SP - SCPS - SCTP - SDRP - SECURE-VMTP - SKIP - SM - SMP - SNP - SPS - SRP - SSCOPMCE - STP - SUN-ND - Sprite-RPC - TCF - TCP - TLSP - TP++ - TRUNK-1 - TRUNK-2 - TTP - UDP - UDPLite - UTI - VINES - VISA - VMTP - WB-EXPAK - WB-MON - WESP - WSN - XNET - XNS-IDP - XTP - manet type: string - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: port schema: items: type: string type: array style: form - explode: true in: query name: port__ic schema: items: type: string type: array style: form - explode: true in: query name: port__ie schema: items: type: string type: array style: form - explode: true in: query name: port__iew schema: items: type: string type: array style: form - explode: true in: query name: port__ire schema: items: type: string type: array style: form - explode: true in: query name: port__isw schema: items: type: string type: array style: form - explode: true in: query name: port__n schema: items: type: string type: array style: form - explode: true in: query name: port__nic schema: items: type: string type: array style: form - explode: true in: query name: port__nie schema: items: type: string type: array style: form - explode: true in: query name: port__niew schema: items: type: string type: array style: form - explode: true in: query name: port__nire schema: items: type: string type: array style: form - explode: true in: query name: port__nisw schema: items: type: string type: array style: form - explode: true in: query name: port__nre schema: items: type: string type: array style: form - explode: true in: query name: port__re schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedServiceObjectList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: ServiceObject viewset. operationId: plugins_firewall_service_object_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableServiceObjectRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ServiceObject' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: ServiceObject viewset. operationId: plugins_firewall_service_object_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceObjectRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: ServiceObject viewset. operationId: plugins_firewall_service_object_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableServiceObjectRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ServiceObject' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/service-object/{id}/: delete: description: ServiceObject viewset. operationId: plugins_firewall_service_object_destroy parameters: - description: A UUID string identifying this service object. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: ServiceObject viewset. operationId: plugins_firewall_service_object_retrieve parameters: - description: A UUID string identifying this service object. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: ServiceObject viewset. operationId: plugins_firewall_service_object_partial_update parameters: - description: A UUID string identifying this service object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedServiceObjectRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: ServiceObject viewset. operationId: plugins_firewall_service_object_update parameters: - description: A UUID string identifying this service object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceObjectRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ServiceObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/service-object/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_service_object_notes_list parameters: - description: A UUID string identifying this service object. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_service_object_notes_create parameters: - description: A UUID string identifying this service object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/user-object-group/: delete: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - explode: true in: query name: user_objects schema: items: format: uuid type: string type: array style: form - explode: true in: query name: user_objects__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedUserObjectGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableUserObjectGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/UserObjectGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableUserObjectGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableUserObjectGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/UserObjectGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/user-object-group/{id}/: delete: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_destroy parameters: - description: A UUID string identifying this user object group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_retrieve parameters: - description: A UUID string identifying this user object group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_partial_update parameters: - description: A UUID string identifying this user object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableUserObjectGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: UserObjectGroup viewset. operationId: plugins_firewall_user_object_group_update parameters: - description: A UUID string identifying this user object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableUserObjectGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObjectGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/user-object-group/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_user_object_group_notes_list parameters: - description: A UUID string identifying this user object group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_user_object_group_notes_create parameters: - description: A UUID string identifying this user object group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/user-object/: delete: description: UserObject viewset. operationId: plugins_firewall_user_object_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: UserObject viewset. operationId: plugins_firewall_user_object_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - explode: true in: query name: username schema: items: type: string type: array style: form - explode: true in: query name: username__ic schema: items: type: string type: array style: form - explode: true in: query name: username__ie schema: items: type: string type: array style: form - explode: true in: query name: username__iew schema: items: type: string type: array style: form - explode: true in: query name: username__ire schema: items: type: string type: array style: form - explode: true in: query name: username__isw schema: items: type: string type: array style: form - explode: true in: query name: username__n schema: items: type: string type: array style: form - explode: true in: query name: username__nic schema: items: type: string type: array style: form - explode: true in: query name: username__nie schema: items: type: string type: array style: form - explode: true in: query name: username__niew schema: items: type: string type: array style: form - explode: true in: query name: username__nire schema: items: type: string type: array style: form - explode: true in: query name: username__nisw schema: items: type: string type: array style: form - explode: true in: query name: username__nre schema: items: type: string type: array style: form - explode: true in: query name: username__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedUserObjectList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: UserObject viewset. operationId: plugins_firewall_user_object_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableUserObjectRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/UserObject' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: UserObject viewset. operationId: plugins_firewall_user_object_create requestBody: content: application/json: schema: $ref: '#/components/schemas/UserObjectRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: UserObject viewset. operationId: plugins_firewall_user_object_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableUserObjectRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/UserObject' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/user-object/{id}/: delete: description: UserObject viewset. operationId: plugins_firewall_user_object_destroy parameters: - description: A UUID string identifying this user object. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: UserObject viewset. operationId: plugins_firewall_user_object_retrieve parameters: - description: A UUID string identifying this user object. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: UserObject viewset. operationId: plugins_firewall_user_object_partial_update parameters: - description: A UUID string identifying this user object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserObjectRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: UserObject viewset. operationId: plugins_firewall_user_object_update parameters: - description: A UUID string identifying this user object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UserObjectRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/UserObject' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/user-object/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_user_object_notes_list parameters: - description: A UUID string identifying this user object. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_user_object_notes_create parameters: - description: A UUID string identifying this user object. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/zone/: delete: description: Zone viewset. operationId: plugins_firewall_zone_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Zone viewset. operationId: plugins_firewall_zone_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: interfaces schema: items: format: uuid type: string type: array style: form - explode: true in: query name: interfaces__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: type: string type: array style: form - explode: true in: query name: status__n schema: items: type: string type: array style: form - explode: true in: query name: vrfs schema: items: format: uuid type: string type: array style: form - explode: true in: query name: vrfs__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedZoneList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: Zone viewset. operationId: plugins_firewall_zone_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableZoneRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Zone' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: Zone viewset. operationId: plugins_firewall_zone_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ZoneRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Zone' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: Zone viewset. operationId: plugins_firewall_zone_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableZoneRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Zone' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/zone/{id}/: delete: description: Zone viewset. operationId: plugins_firewall_zone_destroy parameters: - description: A UUID string identifying this zone. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: Zone viewset. operationId: plugins_firewall_zone_retrieve parameters: - description: A UUID string identifying this zone. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Zone' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: Zone viewset. operationId: plugins_firewall_zone_partial_update parameters: - description: A UUID string identifying this zone. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZoneRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Zone' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: Zone viewset. operationId: plugins_firewall_zone_update parameters: - description: A UUID string identifying this zone. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ZoneRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Zone' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/firewall/zone/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_zone_notes_list parameters: - description: A UUID string identifying this zone. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API methods for returning or creating notes on an object. operationId: plugins_firewall_zone_notes_create parameters: - description: A UUID string identifying this zone. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/compliance-feature/: delete: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_list parameters: - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: name schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: slug schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedComplianceFeatureList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableComplianceFeatureRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ComplianceFeature' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ComplianceFeatureRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceFeature' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableComplianceFeatureRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ComplianceFeature' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/compliance-feature/{id}/: delete: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_destroy parameters: - description: A UUID string identifying this compliance feature. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_retrieve parameters: - description: A UUID string identifying this compliance feature. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceFeature' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_partial_update parameters: - description: A UUID string identifying this compliance feature. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedComplianceFeatureRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceFeature' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ComplianceFeature objects. operationId: plugins_golden_config_compliance_feature_update parameters: - description: A UUID string identifying this compliance feature. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ComplianceFeatureRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceFeature' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/compliance-rule/: delete: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_list parameters: - in: query name: feature schema: format: uuid type: string - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Platform (ID) explode: true in: query name: platform_id schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedComplianceRuleList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableComplianceRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ComplianceRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ComplianceRuleRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableComplianceRuleRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ComplianceRule' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/compliance-rule/{id}/: delete: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_destroy parameters: - description: A UUID string identifying this compliance rule. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_retrieve parameters: - description: A UUID string identifying this compliance rule. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_partial_update parameters: - description: A UUID string identifying this compliance rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedComplianceRuleRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ComplianceRule objects. operationId: plugins_golden_config_compliance_rule_update parameters: - description: A UUID string identifying this compliance rule. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ComplianceRuleRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ComplianceRule' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-compliance/: delete: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_list parameters: - description: Device Name explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device ID explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device Status explode: true in: query name: device_status schema: items: format: uuid type: string type: array style: form - description: Device Status explode: true in: query name: device_status_id schema: items: format: uuid nullable: true type: string type: array style: form - description: DeviceType (slug) explode: true in: query name: device_type schema: items: type: string type: array style: form - description: Device type (ID) explode: true in: query name: device_type_id schema: items: format: uuid type: string type: array style: form - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Manufacturer (slug) explode: true in: query name: manufacturer schema: items: type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Platform (ID) explode: true in: query name: platform_id schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Rack (name) explode: true in: query name: rack schema: items: type: string type: array style: form - description: Rack group (slug) explode: true in: query name: rack_group schema: items: type: string type: array style: form - description: Rack group (ID) explode: true in: query name: rack_group_id schema: items: format: uuid type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Tenant (slug) explode: true in: query name: tenant schema: items: type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConfigComplianceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConfigComplianceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigCompliance' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigComplianceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigCompliance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConfigComplianceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigCompliance' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-compliance/{id}/: delete: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_destroy parameters: - description: A UUID string identifying this config compliance. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_retrieve parameters: - description: A UUID string identifying this config compliance. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigCompliance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_partial_update parameters: - description: A UUID string identifying this config compliance. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedConfigComplianceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigCompliance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ConfigCompliance objects. operationId: plugins_golden_config_config_compliance_update parameters: - description: A UUID string identifying this config compliance. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigComplianceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigCompliance' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-postprocessing/{id}/: get: description: Detail REST API view showing configuration after postprocessing. operationId: plugins_golden_config_config_postprocessing_retrieve parameters: - description: A UUID string identifying this device. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigToPush' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-remove/: delete: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_list parameters: - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: name schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Platform (ID) explode: true in: query name: platform_id schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConfigRemoveList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConfigRemoveRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigRemove' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigRemoveRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigRemove' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConfigRemoveRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigRemove' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-remove/{id}/: delete: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_destroy parameters: - description: A UUID string identifying this config remove. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_retrieve parameters: - description: A UUID string identifying this config remove. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigRemove' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_partial_update parameters: - description: A UUID string identifying this config remove. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedConfigRemoveRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigRemove' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ConfigRemove objects. operationId: plugins_golden_config_config_remove_update parameters: - description: A UUID string identifying this config remove. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigRemoveRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigRemove' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-replace/: delete: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_list parameters: - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: name schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Platform (ID) explode: true in: query name: platform_id schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedConfigReplaceList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableConfigReplaceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigReplace' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigReplaceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigReplace' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableConfigReplaceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ConfigReplace' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/config-replace/{id}/: delete: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_destroy parameters: - description: A UUID string identifying this config replace. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_retrieve parameters: - description: A UUID string identifying this config replace. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigReplace' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_partial_update parameters: - description: A UUID string identifying this config replace. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedConfigReplaceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigReplace' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with ConfigReplace objects. operationId: plugins_golden_config_config_replace_update parameters: - description: A UUID string identifying this config replace. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigReplaceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ConfigReplace' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/golden-config-settings/: delete: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_list parameters: - in: query name: backup_repository schema: format: uuid type: string - in: query name: backup_repository__n schema: format: uuid type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: intended_repository schema: format: uuid type: string - in: query name: intended_repository__n schema: format: uuid type: string - in: query name: jinja_repository schema: format: uuid type: string - in: query name: jinja_repository__n schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: weight schema: items: type: integer type: array style: form - explode: true in: query name: weight__gt schema: items: type: integer type: array style: form - explode: true in: query name: weight__gte schema: items: type: integer type: array style: form - explode: true in: query name: weight__lt schema: items: type: integer type: array style: form - explode: true in: query name: weight__lte schema: items: type: integer type: array style: form - explode: true in: query name: weight__n schema: items: type: integer type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedGoldenConfigSettingList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableGoldenConfigSettingRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GoldenConfigSetting' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableGoldenConfigSettingRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfigSetting' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableGoldenConfigSettingRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GoldenConfigSetting' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/golden-config-settings/{id}/: delete: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_destroy parameters: - description: A UUID string identifying this Golden Config Setting. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_retrieve parameters: - description: A UUID string identifying this Golden Config Setting. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfigSetting' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_partial_update parameters: - description: A UUID string identifying this Golden Config Setting. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableGoldenConfigSettingRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfigSetting' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with GoldenConfigSetting objects. operationId: plugins_golden_config_golden_config_settings_update parameters: - description: A UUID string identifying this Golden Config Setting. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableGoldenConfigSettingRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfigSetting' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/golden-config/: delete: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_list parameters: - description: Device Name explode: true in: query name: device schema: items: nullable: true type: string type: array style: form - description: Device ID explode: true in: query name: device_id schema: items: format: uuid type: string type: array style: form - description: Device Status explode: true in: query name: device_status schema: items: format: uuid type: string type: array style: form - description: Device Status explode: true in: query name: device_status_id schema: items: format: uuid nullable: true type: string type: array style: form - description: DeviceType (slug) explode: true in: query name: device_type schema: items: type: string type: array style: form - description: Device type (ID) explode: true in: query name: device_type_id schema: items: format: uuid type: string type: array style: form - in: query name: id schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Manufacturer (slug) explode: true in: query name: manufacturer schema: items: type: string type: array style: form - description: Manufacturer (ID) explode: true in: query name: manufacturer_id schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) explode: true in: query name: platform schema: items: type: string type: array style: form - description: Platform (ID) explode: true in: query name: platform_id schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - description: Rack (name) explode: true in: query name: rack schema: items: type: string type: array style: form - description: Rack group (slug) explode: true in: query name: rack_group schema: items: type: string type: array style: form - description: Rack group (ID) explode: true in: query name: rack_group_id schema: items: format: uuid type: string type: array style: form - description: Rack (ID) explode: true in: query name: rack_id schema: items: format: uuid type: string type: array style: form - description: Region (slug) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (ID) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Role (slug) explode: true in: query name: role schema: items: type: string type: array style: form - description: Role (ID) explode: true in: query name: role_id schema: items: format: uuid type: string type: array style: form - description: Site name (slug) explode: true in: query name: site schema: items: type: string type: array style: form - description: Site (ID) explode: true in: query name: site_id schema: items: format: uuid type: string type: array style: form - description: Tenant (slug) explode: true in: query name: tenant schema: items: type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedGoldenConfigList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableGoldenConfigRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GoldenConfig' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_create requestBody: content: application/json: schema: $ref: '#/components/schemas/GoldenConfigRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfig' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableGoldenConfigRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/GoldenConfig' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/golden-config/{id}/: delete: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_destroy parameters: - description: A UUID string identifying this golden config. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_retrieve parameters: - description: A UUID string identifying this golden config. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfig' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_partial_update parameters: - description: A UUID string identifying this golden config. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGoldenConfigRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfig' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: API viewset for interacting with GoldenConfig objects. operationId: plugins_golden_config_golden_config_update parameters: - description: A UUID string identifying this golden config. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GoldenConfigRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/GoldenConfig' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/golden-config/sotagg/{id}/: get: description: Get method serialize for a dictionary to json response. operationId: plugins_golden_config_sotagg_retrieve parameters: - in: path name: id required: true schema: format: uuid type: string responses: '200': description: No response body security: - cookieAuth: [] - tokenAuth: [] - {} tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/contact/: delete: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_list parameters: - explode: true in: query name: address schema: items: type: string type: array style: form - explode: true in: query name: address__ic schema: items: type: string type: array style: form - explode: true in: query name: address__ie schema: items: type: string type: array style: form - explode: true in: query name: address__iew schema: items: type: string type: array style: form - explode: true in: query name: address__ire schema: items: type: string type: array style: form - explode: true in: query name: address__isw schema: items: type: string type: array style: form - explode: true in: query name: address__n schema: items: type: string type: array style: form - explode: true in: query name: address__nic schema: items: type: string type: array style: form - explode: true in: query name: address__nie schema: items: type: string type: array style: form - explode: true in: query name: address__niew schema: items: type: string type: array style: form - explode: true in: query name: address__nire schema: items: type: string type: array style: form - explode: true in: query name: address__nisw schema: items: type: string type: array style: form - explode: true in: query name: address__nre schema: items: type: string type: array style: form - explode: true in: query name: address__re schema: items: type: string type: array style: form - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - in: query name: contract schema: format: uuid type: string - in: query name: contract__n schema: format: uuid type: string - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: email schema: items: type: string type: array style: form - explode: true in: query name: email__ic schema: items: type: string type: array style: form - explode: true in: query name: email__ie schema: items: type: string type: array style: form - explode: true in: query name: email__iew schema: items: type: string type: array style: form - explode: true in: query name: email__ire schema: items: type: string type: array style: form - explode: true in: query name: email__isw schema: items: type: string type: array style: form - explode: true in: query name: email__n schema: items: type: string type: array style: form - explode: true in: query name: email__nic schema: items: type: string type: array style: form - explode: true in: query name: email__nie schema: items: type: string type: array style: form - explode: true in: query name: email__niew schema: items: type: string type: array style: form - explode: true in: query name: email__nire schema: items: type: string type: array style: form - explode: true in: query name: email__nisw schema: items: type: string type: array style: form - explode: true in: query name: email__nre schema: items: type: string type: array style: form - explode: true in: query name: email__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: phone schema: items: type: string type: array style: form - explode: true in: query name: phone__ic schema: items: type: string type: array style: form - explode: true in: query name: phone__ie schema: items: type: string type: array style: form - explode: true in: query name: phone__iew schema: items: type: string type: array style: form - explode: true in: query name: phone__ire schema: items: type: string type: array style: form - explode: true in: query name: phone__isw schema: items: type: string type: array style: form - explode: true in: query name: phone__n schema: items: type: string type: array style: form - explode: true in: query name: phone__nic schema: items: type: string type: array style: form - explode: true in: query name: phone__nie schema: items: type: string type: array style: form - explode: true in: query name: phone__niew schema: items: type: string type: array style: form - explode: true in: query name: phone__nire schema: items: type: string type: array style: form - explode: true in: query name: phone__nisw schema: items: type: string type: array style: form - explode: true in: query name: phone__nre schema: items: type: string type: array style: form - explode: true in: query name: phone__re schema: items: type: string type: array style: form - explode: true in: query name: priority schema: items: type: integer type: array style: form - explode: true in: query name: priority__gt schema: items: type: integer type: array style: form - explode: true in: query name: priority__gte schema: items: type: integer type: array style: form - explode: true in: query name: priority__lt schema: items: type: integer type: array style: form - explode: true in: query name: priority__lte schema: items: type: integer type: array style: form - explode: true in: query name: priority__n schema: items: type: integer type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: type schema: items: type: string type: array style: form - explode: true in: query name: type__ic schema: items: type: string type: array style: form - explode: true in: query name: type__ie schema: items: type: string type: array style: form - explode: true in: query name: type__iew schema: items: type: string type: array style: form - explode: true in: query name: type__ire schema: items: type: string type: array style: form - explode: true in: query name: type__isw schema: items: type: string type: array style: form - explode: true in: query name: type__n schema: items: type: string type: array style: form - explode: true in: query name: type__nic schema: items: type: string type: array style: form - explode: true in: query name: type__nie schema: items: type: string type: array style: form - explode: true in: query name: type__niew schema: items: type: string type: array style: form - explode: true in: query name: type__nire schema: items: type: string type: array style: form - explode: true in: query name: type__nisw schema: items: type: string type: array style: form - explode: true in: query name: type__nre schema: items: type: string type: array style: form - explode: true in: query name: type__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedContactLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableContactLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ContactLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableContactLCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContactLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableContactLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ContactLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/contact/{id}/: delete: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_destroy parameters: - description: A UUID string identifying this Contract POC. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_retrieve parameters: - description: A UUID string identifying this Contract POC. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContactLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_partial_update parameters: - description: A UUID string identifying this Contract POC. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableContactLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContactLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Contact Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contact_update parameters: - description: A UUID string identifying this Contract POC. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableContactLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContactLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/contract/: delete: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_list parameters: - explode: true in: query name: contract_type schema: items: type: string type: array style: form - explode: true in: query name: contract_type__ic schema: items: type: string type: array style: form - explode: true in: query name: contract_type__ie schema: items: type: string type: array style: form - explode: true in: query name: contract_type__iew schema: items: type: string type: array style: form - explode: true in: query name: contract_type__ire schema: items: type: string type: array style: form - explode: true in: query name: contract_type__isw schema: items: type: string type: array style: form - explode: true in: query name: contract_type__n schema: items: type: string type: array style: form - explode: true in: query name: contract_type__nic schema: items: type: string type: array style: form - explode: true in: query name: contract_type__nie schema: items: type: string type: array style: form - explode: true in: query name: contract_type__niew schema: items: type: string type: array style: form - explode: true in: query name: contract_type__nire schema: items: type: string type: array style: form - explode: true in: query name: contract_type__nisw schema: items: type: string type: array style: form - explode: true in: query name: contract_type__nre schema: items: type: string type: array style: form - explode: true in: query name: contract_type__re schema: items: type: string type: array style: form - explode: true in: query name: cost schema: items: type: number type: array style: form - explode: true in: query name: cost__gt schema: items: type: number type: array style: form - explode: true in: query name: cost__gte schema: items: type: number type: array style: form - explode: true in: query name: cost__lt schema: items: type: number type: array style: form - explode: true in: query name: cost__lte schema: items: type: number type: array style: form - explode: true in: query name: cost__n schema: items: type: number type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: end schema: format: date type: string - in: query name: end__gte schema: format: date type: string - in: query name: end__lte schema: format: date type: string - description: Expired in: query name: expired schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Provider explode: true in: query name: provider schema: items: format: uuid type: string type: array style: form - description: Provider explode: true in: query name: provider__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - in: query name: start schema: format: date type: string - in: query name: start__gte schema: format: date type: string - in: query name: start__lte schema: format: date type: string - explode: true in: query name: support_level schema: items: type: string type: array style: form - explode: true in: query name: support_level__ic schema: items: type: string type: array style: form - explode: true in: query name: support_level__ie schema: items: type: string type: array style: form - explode: true in: query name: support_level__iew schema: items: type: string type: array style: form - explode: true in: query name: support_level__ire schema: items: type: string type: array style: form - explode: true in: query name: support_level__isw schema: items: type: string type: array style: form - explode: true in: query name: support_level__n schema: items: type: string type: array style: form - explode: true in: query name: support_level__nic schema: items: type: string type: array style: form - explode: true in: query name: support_level__nie schema: items: type: string type: array style: form - explode: true in: query name: support_level__niew schema: items: type: string type: array style: form - explode: true in: query name: support_level__nire schema: items: type: string type: array style: form - explode: true in: query name: support_level__nisw schema: items: type: string type: array style: form - explode: true in: query name: support_level__nre schema: items: type: string type: array style: form - explode: true in: query name: support_level__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedContractLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableContractLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ContractLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableContractLCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContractLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableContractLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ContractLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/contract/{id}/: delete: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_destroy parameters: - description: A UUID string identifying this Contract. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_retrieve parameters: - description: A UUID string identifying this Contract. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContractLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_partial_update parameters: - description: A UUID string identifying this Contract. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableContractLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContractLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Contract Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_contract_update parameters: - description: A UUID string identifying this Contract. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableContractLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ContractLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/cve/: delete: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_list parameters: - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: cvss schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss__n schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v2 schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v2__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v2__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v2__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v2__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v2__n schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v3 schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v3__gt schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v3__gte schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v3__lt schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v3__lte schema: items: format: float type: number type: array style: form - explode: true in: query name: cvss_v3__n schema: items: format: float type: number type: array style: form - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: exclude_status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: exclude_status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: fix schema: items: type: string type: array style: form - explode: true in: query name: fix__ic schema: items: type: string type: array style: form - explode: true in: query name: fix__ie schema: items: type: string type: array style: form - explode: true in: query name: fix__iew schema: items: type: string type: array style: form - explode: true in: query name: fix__ire schema: items: type: string type: array style: form - explode: true in: query name: fix__isw schema: items: type: string type: array style: form - explode: true in: query name: fix__n schema: items: type: string type: array style: form - explode: true in: query name: fix__nic schema: items: type: string type: array style: form - explode: true in: query name: fix__nie schema: items: type: string type: array style: form - explode: true in: query name: fix__niew schema: items: type: string type: array style: form - explode: true in: query name: fix__nire schema: items: type: string type: array style: form - explode: true in: query name: fix__nisw schema: items: type: string type: array style: form - explode: true in: query name: fix__nre schema: items: type: string type: array style: form - explode: true in: query name: fix__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: link schema: items: type: string type: array style: form - explode: true in: query name: link__ic schema: items: type: string type: array style: form - explode: true in: query name: link__ie schema: items: type: string type: array style: form - explode: true in: query name: link__iew schema: items: type: string type: array style: form - explode: true in: query name: link__ire schema: items: type: string type: array style: form - explode: true in: query name: link__isw schema: items: type: string type: array style: form - explode: true in: query name: link__n schema: items: type: string type: array style: form - explode: true in: query name: link__nic schema: items: type: string type: array style: form - explode: true in: query name: link__nie schema: items: type: string type: array style: form - explode: true in: query name: link__niew schema: items: type: string type: array style: form - explode: true in: query name: link__nire schema: items: type: string type: array style: form - explode: true in: query name: link__nisw schema: items: type: string type: array style: form - explode: true in: query name: link__nre schema: items: type: string type: array style: form - explode: true in: query name: link__re schema: items: type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: published_date__gte schema: format: date type: string - in: query name: published_date__lte schema: format: date type: string - in: query name: published_date_after schema: format: date-time type: string - in: query name: published_date_before schema: format: date-time type: string - description: Search in: query name: q schema: type: string - in: query name: severity schema: type: string - in: query name: severity__n schema: type: string - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedCVELCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableCVELCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CVELCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCVELCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CVELCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableCVELCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/CVELCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/cve/{id}/: delete: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_destroy parameters: - description: A UUID string identifying this CVE. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_retrieve parameters: - description: A UUID string identifying this CVE. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CVELCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_partial_update parameters: - description: A UUID string identifying this CVE. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableCVELCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CVELCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for CVELCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_cve_update parameters: - description: A UUID string identifying this CVE. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableCVELCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/CVELCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/hardware/: delete: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device Type (Slug) explode: true in: query name: device_type schema: items: type: string type: array style: form - description: Device Type (Slug) explode: true in: query name: device_type__n schema: items: type: string type: array style: form - description: Device Type explode: true in: query name: device_type_id schema: items: format: uuid type: string type: array style: form - description: Device Type explode: true in: query name: device_type_id__n schema: items: format: uuid type: string type: array style: form - in: query name: documentation_url schema: type: string - in: query name: end_of_sale schema: format: date type: string - in: query name: end_of_sale__gte schema: format: date type: string - in: query name: end_of_sale__lte schema: format: date type: string - in: query name: end_of_security_patches schema: format: date type: string - in: query name: end_of_security_patches__gte schema: format: date type: string - in: query name: end_of_security_patches__lte schema: format: date type: string - in: query name: end_of_support schema: format: date type: string - in: query name: end_of_support__gte schema: format: date type: string - in: query name: end_of_support__lte schema: format: date type: string - in: query name: end_of_sw_releases schema: format: date type: string - in: query name: end_of_sw_releases__gte schema: format: date type: string - in: query name: end_of_sw_releases__lte schema: format: date type: string - description: Expired in: query name: expired schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Inventory Part ID explode: true in: query name: inventory_item schema: items: nullable: true title: Inventory Item Part type: string type: array style: form - description: Inventory Part ID explode: true in: query name: inventory_item__n schema: items: nullable: true title: Inventory Item Part type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedHardwareLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableHardwareLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/HardwareLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableHardwareLCMRequest' responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/HardwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableHardwareLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/HardwareLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/hardware/{id}/: delete: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_destroy parameters: - description: A UUID string identifying this Hardware Notice. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_retrieve parameters: - description: A UUID string identifying this Hardware Notice. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/HardwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_partial_update parameters: - description: A UUID string identifying this Hardware Notice. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableHardwareLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/HardwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Hardware Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_hardware_update parameters: - description: A UUID string identifying this Hardware Notice. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableHardwareLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/HardwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/provider/: delete: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_list parameters: - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - explode: true in: query name: country schema: items: type: string type: array style: form - explode: true in: query name: country__ic schema: items: type: string type: array style: form - explode: true in: query name: country__ie schema: items: type: string type: array style: form - explode: true in: query name: country__iew schema: items: type: string type: array style: form - explode: true in: query name: country__ire schema: items: type: string type: array style: form - explode: true in: query name: country__isw schema: items: type: string type: array style: form - explode: true in: query name: country__n schema: items: type: string type: array style: form - explode: true in: query name: country__nic schema: items: type: string type: array style: form - explode: true in: query name: country__nie schema: items: type: string type: array style: form - explode: true in: query name: country__niew schema: items: type: string type: array style: form - explode: true in: query name: country__nire schema: items: type: string type: array style: form - explode: true in: query name: country__nisw schema: items: type: string type: array style: form - explode: true in: query name: country__nre schema: items: type: string type: array style: form - explode: true in: query name: country__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: email schema: items: type: string type: array style: form - explode: true in: query name: email__ic schema: items: type: string type: array style: form - explode: true in: query name: email__ie schema: items: type: string type: array style: form - explode: true in: query name: email__iew schema: items: type: string type: array style: form - explode: true in: query name: email__ire schema: items: type: string type: array style: form - explode: true in: query name: email__isw schema: items: type: string type: array style: form - explode: true in: query name: email__n schema: items: type: string type: array style: form - explode: true in: query name: email__nic schema: items: type: string type: array style: form - explode: true in: query name: email__nie schema: items: type: string type: array style: form - explode: true in: query name: email__niew schema: items: type: string type: array style: form - explode: true in: query name: email__nire schema: items: type: string type: array style: form - explode: true in: query name: email__nisw schema: items: type: string type: array style: form - explode: true in: query name: email__nre schema: items: type: string type: array style: form - explode: true in: query name: email__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - explode: true in: query name: phone schema: items: type: string type: array style: form - explode: true in: query name: phone__ic schema: items: type: string type: array style: form - explode: true in: query name: phone__ie schema: items: type: string type: array style: form - explode: true in: query name: phone__iew schema: items: type: string type: array style: form - explode: true in: query name: phone__ire schema: items: type: string type: array style: form - explode: true in: query name: phone__isw schema: items: type: string type: array style: form - explode: true in: query name: phone__n schema: items: type: string type: array style: form - explode: true in: query name: phone__nic schema: items: type: string type: array style: form - explode: true in: query name: phone__nie schema: items: type: string type: array style: form - explode: true in: query name: phone__niew schema: items: type: string type: array style: form - explode: true in: query name: phone__nire schema: items: type: string type: array style: form - explode: true in: query name: phone__nisw schema: items: type: string type: array style: form - explode: true in: query name: phone__nre schema: items: type: string type: array style: form - explode: true in: query name: phone__re schema: items: type: string type: array style: form - explode: true in: query name: physical_address schema: items: type: string type: array style: form - explode: true in: query name: physical_address__ic schema: items: type: string type: array style: form - explode: true in: query name: physical_address__ie schema: items: type: string type: array style: form - explode: true in: query name: physical_address__iew schema: items: type: string type: array style: form - explode: true in: query name: physical_address__ire schema: items: type: string type: array style: form - explode: true in: query name: physical_address__isw schema: items: type: string type: array style: form - explode: true in: query name: physical_address__n schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nic schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nie schema: items: type: string type: array style: form - explode: true in: query name: physical_address__niew schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nire schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nisw schema: items: type: string type: array style: form - explode: true in: query name: physical_address__nre schema: items: type: string type: array style: form - explode: true in: query name: physical_address__re schema: items: type: string type: array style: form - explode: true in: query name: portal_url schema: items: type: string type: array style: form - explode: true in: query name: portal_url__ic schema: items: type: string type: array style: form - explode: true in: query name: portal_url__ie schema: items: type: string type: array style: form - explode: true in: query name: portal_url__iew schema: items: type: string type: array style: form - explode: true in: query name: portal_url__ire schema: items: type: string type: array style: form - explode: true in: query name: portal_url__isw schema: items: type: string type: array style: form - explode: true in: query name: portal_url__n schema: items: type: string type: array style: form - explode: true in: query name: portal_url__nic schema: items: type: string type: array style: form - explode: true in: query name: portal_url__nie schema: items: type: string type: array style: form - explode: true in: query name: portal_url__niew schema: items: type: string type: array style: form - explode: true in: query name: portal_url__nire schema: items: type: string type: array style: form - explode: true in: query name: portal_url__nisw schema: items: type: string type: array style: form - explode: true in: query name: portal_url__nre schema: items: type: string type: array style: form - explode: true in: query name: portal_url__re schema: items: type: string type: array style: form - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedProviderLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableProviderLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ProviderLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderLCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableProviderLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ProviderLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/provider/{id}/: delete: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_destroy parameters: - description: A UUID string identifying this Vendor. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_retrieve parameters: - description: A UUID string identifying this Vendor. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_partial_update parameters: - description: A UUID string identifying this Vendor. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedProviderLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: CRUD operations set for the Contract Provider Lifecycle Management view. operationId: plugins_nautobot_device_lifecycle_mgmt_provider_update parameters: - description: A UUID string identifying this Vendor. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ProviderLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ProviderLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/software-image/: delete: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: default_image schema: type: boolean - description: Device ID in: query name: device_id schema: type: string - description: Device Name in: query name: device_name schema: type: string - description: Device Types (model) explode: true in: query name: device_types schema: items: type: string type: array style: form - description: Device Types (model) explode: true in: query name: device_types__n schema: items: type: string type: array style: form - description: Device Types explode: true in: query name: device_types_id schema: items: format: uuid type: string type: array style: form - description: Device Types explode: true in: query name: device_types_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: download_url schema: items: type: string type: array style: form - explode: true in: query name: download_url__ic schema: items: type: string type: array style: form - explode: true in: query name: download_url__ie schema: items: type: string type: array style: form - explode: true in: query name: download_url__iew schema: items: type: string type: array style: form - explode: true in: query name: download_url__ire schema: items: type: string type: array style: form - explode: true in: query name: download_url__isw schema: items: type: string type: array style: form - explode: true in: query name: download_url__n schema: items: type: string type: array style: form - explode: true in: query name: download_url__nic schema: items: type: string type: array style: form - explode: true in: query name: download_url__nie schema: items: type: string type: array style: form - explode: true in: query name: download_url__niew schema: items: type: string type: array style: form - explode: true in: query name: download_url__nire schema: items: type: string type: array style: form - explode: true in: query name: download_url__nisw schema: items: type: string type: array style: form - explode: true in: query name: download_url__nre schema: items: type: string type: array style: form - explode: true in: query name: download_url__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: image_file_checksum schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__ic schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__ie schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__iew schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__ire schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__isw schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__n schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__nic schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__nie schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__niew schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__nire schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__nisw schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__nre schema: items: type: string type: array style: form - explode: true in: query name: image_file_checksum__re schema: items: type: string type: array style: form - explode: true in: query name: image_file_name schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__ic schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__ie schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__iew schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__ire schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__isw schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__n schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__nic schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__nie schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__niew schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__nire schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__nre schema: items: type: string type: array style: form - explode: true in: query name: image_file_name__re schema: items: type: string type: array style: form - description: InventoryItem ID in: query name: inventory_item_id schema: type: string - description: Inventory Items (name) explode: true in: query name: inventory_items schema: items: format: uuid type: string type: array style: form - description: Inventory Items (name) explode: true in: query name: inventory_items__n schema: items: format: uuid type: string type: array style: form - description: Inventory Items explode: true in: query name: inventory_items_id schema: items: format: uuid type: string type: array style: form - description: Inventory Items explode: true in: query name: inventory_items_id__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Object Tags (slug) explode: true in: query name: object_tags schema: items: type: string type: array style: form - description: Object Tags (slug) explode: true in: query name: object_tags__n schema: items: type: string type: array style: form - description: Object Tags explode: true in: query name: object_tags_id schema: items: format: uuid type: string type: array style: form - description: Object Tags explode: true in: query name: object_tags_id__n schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Software explode: true in: query name: software schema: items: format: uuid type: string type: array style: form - description: Software explode: true in: query name: software__n schema: items: format: uuid type: string type: array style: form - description: Software (version) explode: true in: query name: software_version schema: items: type: string type: array style: form - description: Software (version) explode: true in: query name: software_version__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedSoftwareImageLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableSoftwareImageLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SoftwareImageLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSoftwareImageLCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareImageLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableSoftwareImageLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SoftwareImageLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/software-image/{id}/: delete: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_destroy parameters: - description: A UUID string identifying this Software Image. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_retrieve parameters: - description: A UUID string identifying this Software Image. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareImageLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_partial_update parameters: - description: A UUID string identifying this Software Image. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableSoftwareImageLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareImageLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for SoftwareImageLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_image_update parameters: - description: A UUID string identifying this Software Image. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSoftwareImageLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareImageLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/software/: delete: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_list parameters: - explode: true in: query name: alias schema: items: type: string type: array style: form - explode: true in: query name: alias__ic schema: items: type: string type: array style: form - explode: true in: query name: alias__ie schema: items: type: string type: array style: form - explode: true in: query name: alias__iew schema: items: type: string type: array style: form - explode: true in: query name: alias__ire schema: items: type: string type: array style: form - explode: true in: query name: alias__isw schema: items: type: string type: array style: form - explode: true in: query name: alias__n schema: items: type: string type: array style: form - explode: true in: query name: alias__nic schema: items: type: string type: array style: form - explode: true in: query name: alias__nie schema: items: type: string type: array style: form - explode: true in: query name: alias__niew schema: items: type: string type: array style: form - explode: true in: query name: alias__nire schema: items: type: string type: array style: form - explode: true in: query name: alias__nisw schema: items: type: string type: array style: form - explode: true in: query name: alias__nre schema: items: type: string type: array style: form - explode: true in: query name: alias__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device Platform (Slug) explode: true in: query name: device_platform schema: items: type: string type: array style: form - description: Device Platform (Slug) explode: true in: query name: device_platform__n schema: items: type: string type: array style: form - in: query name: documentation_url schema: type: string - in: query name: end_of_support_after schema: format: date-time type: string - in: query name: end_of_support_before schema: format: date-time type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - in: query name: long_term_support schema: type: boolean - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: pre_release schema: type: boolean - description: Search in: query name: q schema: type: string - in: query name: release_date_after schema: format: date-time type: string - in: query name: release_date_before schema: format: date-time type: string - explode: true in: query name: version schema: items: type: string type: array style: form - explode: true in: query name: version__ic schema: items: type: string type: array style: form - explode: true in: query name: version__ie schema: items: type: string type: array style: form - explode: true in: query name: version__iew schema: items: type: string type: array style: form - explode: true in: query name: version__ire schema: items: type: string type: array style: form - explode: true in: query name: version__isw schema: items: type: string type: array style: form - explode: true in: query name: version__n schema: items: type: string type: array style: form - explode: true in: query name: version__nic schema: items: type: string type: array style: form - explode: true in: query name: version__nie schema: items: type: string type: array style: form - explode: true in: query name: version__niew schema: items: type: string type: array style: form - explode: true in: query name: version__nire schema: items: type: string type: array style: form - explode: true in: query name: version__nisw schema: items: type: string type: array style: form - explode: true in: query name: version__nre schema: items: type: string type: array style: form - explode: true in: query name: version__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedSoftwareLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableSoftwareLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SoftwareLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSoftwareLCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableSoftwareLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/SoftwareLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/software/{id}/: delete: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_destroy parameters: - description: A UUID string identifying this Software. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_retrieve parameters: - description: A UUID string identifying this Software. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_partial_update parameters: - description: A UUID string identifying this Software. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableSoftwareLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for SoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_software_update parameters: - description: A UUID string identifying this Software. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableSoftwareLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/SoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/validated-software/: delete: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Device ID in: query name: device_id schema: type: string - description: Device Name in: query name: device_name schema: type: string - description: Device Roles (slug) explode: true in: query name: device_roles schema: items: type: string type: array style: form - description: Device Roles (slug) explode: true in: query name: device_roles__n schema: items: type: string type: array style: form - description: Device Roles explode: true in: query name: device_roles_id schema: items: format: uuid type: string type: array style: form - description: Device Roles explode: true in: query name: device_roles_id__n schema: items: format: uuid type: string type: array style: form - description: Device Types (model) explode: true in: query name: device_types schema: items: type: string type: array style: form - description: Device Types (model) explode: true in: query name: device_types__n schema: items: type: string type: array style: form - description: Device Types explode: true in: query name: device_types_id schema: items: format: uuid type: string type: array style: form - description: Device Types explode: true in: query name: device_types_id__n schema: items: format: uuid type: string type: array style: form - description: Devices (name) explode: true in: query name: devices schema: items: nullable: true type: string type: array style: form - description: Devices (name) explode: true in: query name: devices__n schema: items: nullable: true type: string type: array style: form - description: Devices explode: true in: query name: devices_id schema: items: format: uuid type: string type: array style: form - description: Devices explode: true in: query name: devices_id__n schema: items: format: uuid type: string type: array style: form - in: query name: end_after schema: format: date-time type: string - in: query name: end_before schema: format: date-time type: string - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: InventoryItem ID in: query name: inventory_item_id schema: type: string - description: Inventory Items (name) explode: true in: query name: inventory_items schema: items: type: string type: array style: form - description: Inventory Items (name) explode: true in: query name: inventory_items__n schema: items: type: string type: array style: form - description: Inventory Items explode: true in: query name: inventory_items_id schema: items: format: uuid type: string type: array style: form - description: Inventory Items explode: true in: query name: inventory_items_id__n schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Object Tags (slug) explode: true in: query name: object_tags schema: items: type: string type: array style: form - description: Object Tags (slug) explode: true in: query name: object_tags__n schema: items: type: string type: array style: form - description: Object Tags explode: true in: query name: object_tags_id schema: items: format: uuid type: string type: array style: form - description: Object Tags explode: true in: query name: object_tags_id__n schema: items: format: uuid type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - in: query name: preferred schema: type: boolean - description: Search in: query name: q schema: type: string - description: Software explode: true in: query name: software schema: items: format: uuid type: string type: array style: form - description: Software explode: true in: query name: software__n schema: items: format: uuid type: string type: array style: form - in: query name: start_after schema: format: date-time type: string - in: query name: start_before schema: format: date-time type: string - description: Currently valid in: query name: valid schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedValidatedSoftwareLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableValidatedSoftwareLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ValidatedSoftwareLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins post: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableValidatedSoftwareLCMRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ValidatedSoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableValidatedSoftwareLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ValidatedSoftwareLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/validated-software/{id}/: delete: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_destroy parameters: - description: A UUID string identifying this Validated Software. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_retrieve parameters: - description: A UUID string identifying this Validated Software. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ValidatedSoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_partial_update parameters: - description: A UUID string identifying this Validated Software. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableValidatedSoftwareLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ValidatedSoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for ValidatedSoftwareLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_validated_software_update parameters: - description: A UUID string identifying this Validated Software. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableValidatedSoftwareLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ValidatedSoftwareLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/vulnerability/: delete: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - in: query name: cve schema: format: uuid type: string - in: query name: cve__n schema: format: uuid type: string - in: query name: cve__published_date__gte schema: format: date type: string - in: query name: cve__published_date__lte schema: format: date type: string - in: query name: cve__published_date_after schema: format: date-time type: string - in: query name: cve__published_date_before schema: format: date-time type: string - in: query name: device schema: format: uuid type: string - in: query name: device__n schema: format: uuid type: string - explode: true in: query name: exclude_status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: exclude_status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: inventory_item schema: format: uuid type: string - in: query name: inventory_item__n schema: format: uuid type: string - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: software schema: format: uuid type: string - in: query name: software__n schema: format: uuid type: string - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVulnerabilityLCMList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVulnerabilityLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VulnerabilityLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVulnerabilityLCMRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VulnerabilityLCM' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /plugins/nautobot-device-lifecycle-mgmt/vulnerability/{id}/: delete: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_destroy parameters: - description: A UUID string identifying this Vulnerability. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - plugins get: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_retrieve parameters: - description: A UUID string identifying this Vulnerability. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VulnerabilityLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins patch: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_partial_update parameters: - description: A UUID string identifying this Vulnerability. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVulnerabilityLCMRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VulnerabilityLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins put: description: REST API viewset for VulnerabilityLCM records. operationId: plugins_nautobot_device_lifecycle_mgmt_vulnerability_update parameters: - description: A UUID string identifying this Vulnerability. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VulnerabilityLCMRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VulnerabilityLCM' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - plugins /status/: get: description: A lightweight read-only endpoint for conveying the current operational status. operationId: status_retrieve responses: '200': content: application/json; version=1.3: schema: properties: celery-workers-running: type: integer django-version: type: string installed-apps: type: object nautobot-version: type: string plugins: type: object python-version: type: string rq-workers-running: type: integer type: object description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - status /swagger.json: get: description: 'OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json' operationId: swagger.json_retrieve parameters: - in: query name: lang schema: enum: - af - ar - ar-dz - ast - az - be - bg - bn - br - bs - ca - cs - cy - da - de - dsb - el - en - en-au - en-gb - eo - es - es-ar - es-co - es-mx - es-ni - es-ve - et - eu - fa - fi - fr - fy - ga - gd - gl - he - hi - hr - hsb - hu - hy - ia - id - ig - io - is - it - ja - ka - kab - kk - km - kn - ko - ky - lb - lt - lv - mk - ml - mn - mr - my - nb - ne - nl - nn - os - pa - pl - pt - pt-br - ro - ru - sk - sl - sq - sr - sr-latn - sv - sw - ta - te - tg - th - tk - tr - tt - udm - uk - ur - uz - vi - zh-hans - zh-hant type: string responses: '200': content: application/json; version=1.3: schema: additionalProperties: {} type: object application/vnd.oai.openapi+json; version=1.3: schema: additionalProperties: {} type: object description: '' security: - cookieAuth: [] - tokenAuth: [] - {} tags: - swagger.json /swagger.yaml: get: description: 'OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json' operationId: swagger.yaml_retrieve parameters: - in: query name: lang schema: enum: - af - ar - ar-dz - ast - az - be - bg - bn - br - bs - ca - cs - cy - da - de - dsb - el - en - en-au - en-gb - eo - es - es-ar - es-co - es-mx - es-ni - es-ve - et - eu - fa - fi - fr - fy - ga - gd - gl - he - hi - hr - hsb - hu - hy - ia - id - ig - io - is - it - ja - ka - kab - kk - km - kn - ko - ky - lb - lt - lv - mk - ml - mn - mr - my - nb - ne - nl - nn - os - pa - pl - pt - pt-br - ro - ru - sk - sl - sq - sr - sr-latn - sv - sw - ta - te - tg - th - tk - tr - tt - udm - uk - ur - uz - vi - zh-hans - zh-hant type: string responses: '200': content: application/vnd.oai.openapi; version=1.3: schema: additionalProperties: {} type: object application/yaml; version=1.3: schema: additionalProperties: {} type: object description: '' security: - cookieAuth: [] - tokenAuth: [] - {} tags: - swagger.yaml /swagger/: get: description: 'OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json' operationId: swagger_retrieve parameters: - in: query name: format schema: enum: - json - yaml type: string - in: query name: lang schema: enum: - af - ar - ar-dz - ast - az - be - bg - bn - br - bs - ca - cs - cy - da - de - dsb - el - en - en-au - en-gb - eo - es - es-ar - es-co - es-mx - es-ni - es-ve - et - eu - fa - fi - fr - fy - ga - gd - gl - he - hi - hr - hsb - hu - hy - ia - id - ig - io - is - it - ja - ka - kab - kk - km - kn - ko - ky - lb - lt - lv - mk - ml - mn - mr - my - nb - ne - nl - nn - os - pa - pl - pt - pt-br - ro - ru - sk - sl - sq - sr - sr-latn - sv - sw - ta - te - tg - th - tk - tr - tt - udm - uk - ur - uz - vi - zh-hans - zh-hant type: string responses: '200': content: application/json; version=1.3: schema: additionalProperties: {} type: object application/vnd.oai.openapi+json; version=1.3: schema: additionalProperties: {} type: object application/vnd.oai.openapi; version=1.3: schema: additionalProperties: {} type: object application/yaml; version=1.3: schema: additionalProperties: {} type: object description: '' security: - cookieAuth: [] - tokenAuth: [] - {} tags: - swagger /tenancy/tenant-groups/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Tenant group group (slug) explode: true in: query name: parent schema: items: type: string type: array style: form - description: Tenant group group (slug) explode: true in: query name: parent__n schema: items: type: string type: array style: form - description: Tenant group (ID) explode: true in: query name: parent_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant group (ID) explode: true in: query name: parent_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedTenantGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableTenantGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/TenantGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableTenantGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TenantGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableTenantGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/TenantGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy /tenancy/tenant-groups/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_destroy parameters: - description: A UUID string identifying this tenant group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_retrieve parameters: - description: A UUID string identifying this tenant group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TenantGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_partial_update parameters: - description: A UUID string identifying this tenant group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableTenantGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TenantGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenant_groups_update parameters: - description: A UUID string identifying this tenant group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableTenantGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/TenantGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy /tenancy/tenant-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: tenancy_tenant_groups_notes_list parameters: - description: A UUID string identifying this tenant group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy post: description: API methods for returning or creating notes on an object. operationId: tenancy_tenant_groups_notes_create parameters: - description: A UUID string identifying this tenant group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy /tenancy/tenants/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_list parameters: - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Tenant group (slug) explode: true in: query name: group schema: items: format: uuid type: string type: array style: form - description: Tenant group (slug) explode: true in: query name: group__n schema: items: format: uuid type: string type: array style: form - description: Tenant group (ID) explode: true in: query name: group_id schema: items: format: uuid type: string type: array style: form - description: Tenant group (ID) explode: true in: query name: group_id__n schema: items: format: uuid type: string type: array style: form - description: Has locations in: query name: has_locations schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Locations (slugs and/or IDs) explode: true in: query name: locations schema: items: format: uuid type: string type: array style: form - description: Locations (slugs and/or IDs) explode: true in: query name: locations__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedTenantList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableTenantRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Tenant' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableTenantRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Tenant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableTenantRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Tenant' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy /tenancy/tenants/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_destroy parameters: - description: A UUID string identifying this tenant. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_retrieve parameters: - description: A UUID string identifying this tenant. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Tenant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_partial_update parameters: - description: A UUID string identifying this tenant. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableTenantRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Tenant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: tenancy_tenants_update parameters: - description: A UUID string identifying this tenant. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableTenantRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Tenant' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy /tenancy/tenants/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: tenancy_tenants_notes_list parameters: - description: A UUID string identifying this tenant. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy post: description: API methods for returning or creating notes on an object. operationId: tenancy_tenants_notes_create parameters: - description: A UUID string identifying this tenant. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - tenancy /users/config/: get: description: Return the config_data for the currently authenticated User. operationId: users_config_retrieve responses: '200': content: application/json; version=1.3: schema: additionalProperties: {} type: object description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /users/groups/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationIntegerIDRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_list parameters: - explode: true in: query name: id schema: items: type: integer type: array style: form - explode: true in: query name: id__gt schema: items: type: integer type: array style: form - explode: true in: query name: id__gte schema: items: type: integer type: array style: form - explode: true in: query name: id__lt schema: items: type: integer type: array style: form - explode: true in: query name: id__lte schema: items: type: integer type: array style: form - explode: true in: query name: id__n schema: items: type: integer type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Group' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Group' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Group' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /users/groups/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_destroy parameters: - description: A unique integer value identifying this group. in: path name: id required: true schema: type: integer responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_retrieve parameters: - description: A unique integer value identifying this group. in: path name: id required: true schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Group' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_partial_update parameters: - description: A unique integer value identifying this group. in: path name: id required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Group' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_groups_update parameters: - description: A unique integer value identifying this group. in: path name: id required: true schema: type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/GroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Group' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /users/permissions/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_list parameters: - in: query name: enabled schema: type: boolean - description: Group (name) explode: true in: query name: group schema: items: type: string type: array style: form - description: Group (name) explode: true in: query name: group__n schema: items: type: string type: array style: form - description: Group explode: true in: query name: group_id schema: items: type: integer type: array style: form - description: Group explode: true in: query name: group_id__n schema: items: type: integer type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - explode: true in: query name: object_types schema: items: type: integer type: array style: form - explode: true in: query name: object_types__n schema: items: type: integer type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: User (name) explode: true in: query name: user schema: items: type: string type: array style: form - description: User (name) explode: true in: query name: user__n schema: items: type: string type: array style: form - description: User explode: true in: query name: user_id schema: items: format: uuid type: string type: array style: form - description: User explode: true in: query name: user_id__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedObjectPermissionList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableObjectPermissionRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ObjectPermission' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableObjectPermissionRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ObjectPermission' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableObjectPermissionRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ObjectPermission' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /users/permissions/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_destroy parameters: - description: A UUID string identifying this permission. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_retrieve parameters: - description: A UUID string identifying this permission. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ObjectPermission' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_partial_update parameters: - description: A UUID string identifying this permission. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableObjectPermissionRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ObjectPermission' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_permissions_update parameters: - description: A UUID string identifying this permission. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableObjectPermissionRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ObjectPermission' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /users/tokens/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_list parameters: - explode: true in: query name: created schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__gt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__gte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__lt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__lte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: created__n schema: items: format: date-time type: string type: array style: form - explode: true in: query name: expires schema: items: format: date-time type: string type: array style: form - explode: true in: query name: expires__gt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: expires__gte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: expires__lt schema: items: format: date-time type: string type: array style: form - explode: true in: query name: expires__lte schema: items: format: date-time type: string type: array style: form - explode: true in: query name: expires__n schema: items: format: date-time type: string type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - explode: true in: query name: key schema: items: type: string type: array style: form - explode: true in: query name: key__ic schema: items: type: string type: array style: form - explode: true in: query name: key__ie schema: items: type: string type: array style: form - explode: true in: query name: key__iew schema: items: type: string type: array style: form - explode: true in: query name: key__ire schema: items: type: string type: array style: form - explode: true in: query name: key__isw schema: items: type: string type: array style: form - explode: true in: query name: key__n schema: items: type: string type: array style: form - explode: true in: query name: key__nic schema: items: type: string type: array style: form - explode: true in: query name: key__nie schema: items: type: string type: array style: form - explode: true in: query name: key__niew schema: items: type: string type: array style: form - explode: true in: query name: key__nire schema: items: type: string type: array style: form - explode: true in: query name: key__nisw schema: items: type: string type: array style: form - explode: true in: query name: key__nre schema: items: type: string type: array style: form - explode: true in: query name: key__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - in: query name: write_enabled schema: type: boolean responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedTokenList' description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableTokenRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Token' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_create requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenRequest' responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Token' description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableTokenRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Token' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users /users/tokens/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_destroy parameters: - description: A UUID string identifying this token. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_retrieve parameters: - description: A UUID string identifying this token. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Token' description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_partial_update parameters: - description: A UUID string identifying this token. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTokenRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Token' description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_tokens_update parameters: - description: A UUID string identifying this token. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Token' description: '' security: - cookieAuth: [] - tokenAuth: [] - basicAuth: [] tags: - users /users/users/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_list parameters: - explode: true in: query name: email schema: items: type: string type: array style: form - explode: true in: query name: email__ic schema: items: type: string type: array style: form - explode: true in: query name: email__ie schema: items: type: string type: array style: form - explode: true in: query name: email__iew schema: items: type: string type: array style: form - explode: true in: query name: email__ire schema: items: type: string type: array style: form - explode: true in: query name: email__isw schema: items: type: string type: array style: form - explode: true in: query name: email__n schema: items: type: string type: array style: form - explode: true in: query name: email__nic schema: items: type: string type: array style: form - explode: true in: query name: email__nie schema: items: type: string type: array style: form - explode: true in: query name: email__niew schema: items: type: string type: array style: form - explode: true in: query name: email__nire schema: items: type: string type: array style: form - explode: true in: query name: email__nisw schema: items: type: string type: array style: form - explode: true in: query name: email__nre schema: items: type: string type: array style: form - explode: true in: query name: email__re schema: items: type: string type: array style: form - explode: true in: query name: first_name schema: items: type: string type: array style: form - explode: true in: query name: first_name__ic schema: items: type: string type: array style: form - explode: true in: query name: first_name__ie schema: items: type: string type: array style: form - explode: true in: query name: first_name__iew schema: items: type: string type: array style: form - explode: true in: query name: first_name__ire schema: items: type: string type: array style: form - explode: true in: query name: first_name__isw schema: items: type: string type: array style: form - explode: true in: query name: first_name__n schema: items: type: string type: array style: form - explode: true in: query name: first_name__nic schema: items: type: string type: array style: form - explode: true in: query name: first_name__nie schema: items: type: string type: array style: form - explode: true in: query name: first_name__niew schema: items: type: string type: array style: form - explode: true in: query name: first_name__nire schema: items: type: string type: array style: form - explode: true in: query name: first_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: first_name__nre schema: items: type: string type: array style: form - explode: true in: query name: first_name__re schema: items: type: string type: array style: form - description: Group (name) explode: true in: query name: group schema: items: type: string type: array style: form - description: Group (name) explode: true in: query name: group__n schema: items: type: string type: array style: form - description: Group explode: true in: query name: group_id schema: items: type: integer type: array style: form - description: Group explode: true in: query name: group_id__n schema: items: type: integer type: array style: form - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: is_active schema: type: boolean - in: query name: is_staff schema: type: boolean - explode: true in: query name: last_name schema: items: type: string type: array style: form - explode: true in: query name: last_name__ic schema: items: type: string type: array style: form - explode: true in: query name: last_name__ie schema: items: type: string type: array style: form - explode: true in: query name: last_name__iew schema: items: type: string type: array style: form - explode: true in: query name: last_name__ire schema: items: type: string type: array style: form - explode: true in: query name: last_name__isw schema: items: type: string type: array style: form - explode: true in: query name: last_name__n schema: items: type: string type: array style: form - explode: true in: query name: last_name__nic schema: items: type: string type: array style: form - explode: true in: query name: last_name__nie schema: items: type: string type: array style: form - explode: true in: query name: last_name__niew schema: items: type: string type: array style: form - explode: true in: query name: last_name__nire schema: items: type: string type: array style: form - explode: true in: query name: last_name__nisw schema: items: type: string type: array style: form - explode: true in: query name: last_name__nre schema: items: type: string type: array style: form - explode: true in: query name: last_name__re schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: username schema: items: type: string type: array style: form - explode: true in: query name: username__ic schema: items: type: string type: array style: form - explode: true in: query name: username__ie schema: items: type: string type: array style: form - explode: true in: query name: username__iew schema: items: type: string type: array style: form - explode: true in: query name: username__ire schema: items: type: string type: array style: form - explode: true in: query name: username__isw schema: items: type: string type: array style: form - explode: true in: query name: username__n schema: items: type: string type: array style: form - explode: true in: query name: username__nic schema: items: type: string type: array style: form - explode: true in: query name: username__nie schema: items: type: string type: array style: form - explode: true in: query name: username__niew schema: items: type: string type: array style: form - explode: true in: query name: username__nire schema: items: type: string type: array style: form - explode: true in: query name: username__nisw schema: items: type: string type: array style: form - explode: true in: query name: username__nre schema: items: type: string type: array style: form - explode: true in: query name: username__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableUserRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/User' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users post: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableUserRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/User' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableUserRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/User' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /users/users/{id}/: delete: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_destroy parameters: - description: A UUID string identifying this user. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - users get: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_retrieve parameters: - description: A UUID string identifying this user. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/User' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users patch: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_partial_update parameters: - description: A UUID string identifying this user. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableUserRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/User' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users put: description: Extend DRF's ModelViewSet to support bulk update and delete functions. operationId: users_users_update parameters: - description: A UUID string identifying this user. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableUserRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/User' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - users /virtualization/cluster-groups/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_list parameters: - description: Clusters (name or ID) explode: true in: query name: clusters schema: items: format: uuid type: string type: array style: form - description: Clusters (name or ID) explode: true in: query name: clusters__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Has clusters in: query name: has_clusters schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedClusterGroupList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableClusterGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ClusterGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterGroupRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableClusterGroupRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ClusterGroup' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/cluster-groups/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_destroy parameters: - description: A UUID string identifying this cluster group. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_retrieve parameters: - description: A UUID string identifying this cluster group. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_partial_update parameters: - description: A UUID string identifying this cluster group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedClusterGroupRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_groups_update parameters: - description: A UUID string identifying this cluster group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterGroupRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterGroup' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/cluster-groups/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: virtualization_cluster_groups_notes_list parameters: - description: A UUID string identifying this cluster group. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: API methods for returning or creating notes on an object. operationId: virtualization_cluster_groups_notes_create parameters: - description: A UUID string identifying this cluster group. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/cluster-types/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_list parameters: - description: Clusters (name or ID) explode: true in: query name: clusters schema: items: format: uuid type: string type: array style: form - description: Clusters (name or ID) explode: true in: query name: clusters__n schema: items: format: uuid type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - description: Has clusters in: query name: has_clusters schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - explode: true in: query name: slug schema: items: type: string type: array style: form - explode: true in: query name: slug__ic schema: items: type: string type: array style: form - explode: true in: query name: slug__ie schema: items: type: string type: array style: form - explode: true in: query name: slug__iew schema: items: type: string type: array style: form - explode: true in: query name: slug__ire schema: items: type: string type: array style: form - explode: true in: query name: slug__isw schema: items: type: string type: array style: form - explode: true in: query name: slug__n schema: items: type: string type: array style: form - explode: true in: query name: slug__nic schema: items: type: string type: array style: form - explode: true in: query name: slug__nie schema: items: type: string type: array style: form - explode: true in: query name: slug__niew schema: items: type: string type: array style: form - explode: true in: query name: slug__nire schema: items: type: string type: array style: form - explode: true in: query name: slug__nisw schema: items: type: string type: array style: form - explode: true in: query name: slug__nre schema: items: type: string type: array style: form - explode: true in: query name: slug__re schema: items: type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedClusterTypeList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableClusterTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ClusterType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_create requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterTypeRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableClusterTypeRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/ClusterType' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/cluster-types/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_destroy parameters: - description: A UUID string identifying this cluster type. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_retrieve parameters: - description: A UUID string identifying this cluster type. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_partial_update parameters: - description: A UUID string identifying this cluster type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedClusterTypeRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_cluster_types_update parameters: - description: A UUID string identifying this cluster type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClusterTypeRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/ClusterType' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/cluster-types/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: virtualization_cluster_types_notes_list parameters: - description: A UUID string identifying this cluster type. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: API methods for returning or creating notes on an object. operationId: virtualization_cluster_types_notes_create parameters: - description: A UUID string identifying this cluster type. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/clusters/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_list parameters: - explode: true in: query name: comments schema: items: type: string type: array style: form - explode: true in: query name: comments__ic schema: items: type: string type: array style: form - explode: true in: query name: comments__ie schema: items: type: string type: array style: form - explode: true in: query name: comments__iew schema: items: type: string type: array style: form - explode: true in: query name: comments__ire schema: items: type: string type: array style: form - explode: true in: query name: comments__isw schema: items: type: string type: array style: form - explode: true in: query name: comments__n schema: items: type: string type: array style: form - explode: true in: query name: comments__nic schema: items: type: string type: array style: form - explode: true in: query name: comments__nie schema: items: type: string type: array style: form - explode: true in: query name: comments__niew schema: items: type: string type: array style: form - explode: true in: query name: comments__nire schema: items: type: string type: array style: form - explode: true in: query name: comments__nisw schema: items: type: string type: array style: form - explode: true in: query name: comments__nre schema: items: type: string type: array style: form - explode: true in: query name: comments__re schema: items: type: string type: array style: form - in: query name: created schema: format: date type: string - in: query name: created__gte schema: format: date type: string - in: query name: created__lte schema: format: date type: string - description: Devices (name or ID) explode: true in: query name: devices schema: items: format: uuid type: string type: array style: form - description: Devices (name or ID) explode: true in: query name: devices__n schema: items: format: uuid type: string type: array style: form - description: Parent group (slug) explode: true in: query name: group schema: items: type: string type: array style: form - description: Parent group (slug) explode: true in: query name: group__n schema: items: type: string type: array style: form - description: Parent group (ID) explode: true in: query name: group_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Parent group (ID) explode: true in: query name: group_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Has devices in: query name: has_devices schema: type: boolean - description: Has virtual machines in: query name: has_virtual_machines schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - in: query name: last_updated schema: format: date-time type: string - in: query name: last_updated__gte schema: format: date-time type: string - in: query name: last_updated__lte schema: format: date-time type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Location (slug or ID) explode: true in: query name: location schema: items: format: uuid type: string type: array style: form - description: Location (slug or ID) explode: true in: query name: location__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Search in: query name: q schema: type: string - description: Region (slug or ID) explode: true in: query name: region schema: items: format: uuid type: string type: array style: form - description: Region (slug or ID) explode: true in: query name: region__n schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id schema: items: format: uuid type: string type: array style: form - description: Region (ID) (deprecated, use "region" filter instead) explode: true in: query name: region_id__n schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site schema: items: format: uuid type: string type: array style: form - description: Site (slug or ID) explode: true in: query name: site__n schema: items: format: uuid type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Site (ID) (deprecated, use "site" filter instead) explode: true in: query name: site_id__n schema: items: format: uuid nullable: true type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant schema: items: format: uuid type: string type: array style: form - description: Tenant (slug or ID) explode: true in: query name: tenant__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group schema: items: format: uuid type: string type: array style: form - description: Tenant Group (slug) explode: true in: query name: tenant_group__n schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id schema: items: format: uuid type: string type: array style: form - description: Tenant Group (ID) explode: true in: query name: tenant_group_id__n schema: items: format: uuid type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id schema: items: format: uuid nullable: true type: string type: array style: form - description: Tenant (ID) (deprecated, use "tenant" filter instead) explode: true in: query name: tenant_id__n schema: items: format: uuid nullable: true type: string type: array style: form - description: Cluster type (slug) explode: true in: query name: type schema: items: type: string type: array style: form - description: Cluster type (slug) explode: true in: query name: type__n schema: items: type: string type: array style: form - description: Cluster type (ID) explode: true in: query name: type_id schema: items: format: uuid type: string type: array style: form - description: Cluster type (ID) explode: true in: query name: type_id__n schema: items: format: uuid type: string type: array style: form - description: Virtual machines (name or ID) explode: true in: query name: virtual_machines schema: items: format: uuid type: string type: array style: form - description: Virtual machines (name or ID) explode: true in: query name: virtual_machines__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedClusterList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableClusterRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Cluster' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableClusterRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cluster' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableClusterRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/Cluster' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/clusters/{id}/: delete: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_destroy parameters: - description: A UUID string identifying this cluster. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_retrieve parameters: - description: A UUID string identifying this cluster. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cluster' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_partial_update parameters: - description: A UUID string identifying this cluster. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableClusterRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cluster' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel. Can also be used for models derived from BaseModel, so long as they support Notes.' operationId: virtualization_clusters_update parameters: - description: A UUID string identifying this cluster. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableClusterRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Cluster' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/clusters/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: virtualization_clusters_notes_list parameters: - description: A UUID string identifying this cluster. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: API methods for returning or creating notes on an object. operationId: virtualization_clusters_notes_create parameters: - description: A UUID string identifying this cluster. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/interfaces/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_list parameters: - description: Bridge interface (name or ID) explode: true in: query name: bridge schema: items: format: uuid type: string type: array style: form - description: Bridge interface (name or ID) explode: true in: query name: bridge__n schema: items: format: uuid type: string type: array style: form - description: Bridged interfaces (name or ID) explode: true in: query name: bridged_interfaces schema: items: format: uuid type: string type: array style: form - description: Bridged interfaces (name or ID) explode: true in: query name: bridged_interfaces__n schema: items: format: uuid type: string type: array style: form - description: Child interfaces (name or ID) explode: true in: query name: child_interfaces schema: items: format: uuid type: string type: array style: form - description: Child interfaces (name or ID) explode: true in: query name: child_interfaces__n schema: items: format: uuid type: string type: array style: form - description: Cluster explode: true in: query name: cluster schema: items: type: string type: array style: form - description: Cluster explode: true in: query name: cluster__n schema: items: type: string type: array style: form - description: Cluster (ID) explode: true in: query name: cluster_id schema: items: format: uuid type: string type: array style: form - description: Cluster (ID) explode: true in: query name: cluster_id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: description schema: items: type: string type: array style: form - explode: true in: query name: description__ic schema: items: type: string type: array style: form - explode: true in: query name: description__ie schema: items: type: string type: array style: form - explode: true in: query name: description__iew schema: items: type: string type: array style: form - explode: true in: query name: description__ire schema: items: type: string type: array style: form - explode: true in: query name: description__isw schema: items: type: string type: array style: form - explode: true in: query name: description__n schema: items: type: string type: array style: form - explode: true in: query name: description__nic schema: items: type: string type: array style: form - explode: true in: query name: description__nie schema: items: type: string type: array style: form - explode: true in: query name: description__niew schema: items: type: string type: array style: form - explode: true in: query name: description__nire schema: items: type: string type: array style: form - explode: true in: query name: description__nisw schema: items: type: string type: array style: form - explode: true in: query name: description__nre schema: items: type: string type: array style: form - explode: true in: query name: description__re schema: items: type: string type: array style: form - in: query name: enabled schema: type: boolean - description: Has Bridged Interfaces in: query name: has_bridged_interfaces schema: type: boolean - description: Has child interfaces in: query name: has_child_interfaces schema: type: boolean - description: Has IP addresses in: query name: has_ip_addresses schema: type: boolean - description: Has Tagged VLANs in: query name: has_tagged_vlans schema: type: boolean - explode: true in: query name: id schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__iew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__ire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__isw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nic schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nie schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__niew schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nire schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nisw schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__nre schema: items: format: uuid type: string type: array style: form - explode: true in: query name: id__re schema: items: format: uuid type: string type: array style: form - description: IP addresses (address or ID) explode: true in: query name: ip_addresses schema: items: type: string type: array style: form - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: MAC address explode: true in: query name: mac_address schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__ic schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__ie schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__iew schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__ire schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__isw schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__n schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__nic schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__nie schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__niew schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__nire schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__nisw schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__nre schema: items: nullable: true type: string type: array style: form - description: MAC address explode: true in: query name: mac_address__re schema: items: nullable: true type: string type: array style: form - in: query name: mode schema: type: string - in: query name: mode__n schema: type: string - explode: true in: query name: mtu schema: items: type: integer type: array style: form - explode: true in: query name: mtu__gt schema: items: type: integer type: array style: form - explode: true in: query name: mtu__gte schema: items: type: integer type: array style: form - explode: true in: query name: mtu__lt schema: items: type: integer type: array style: form - explode: true in: query name: mtu__lte schema: items: type: integer type: array style: form - explode: true in: query name: mtu__n schema: items: type: integer type: array style: form - explode: true in: query name: name schema: items: type: string type: array style: form - explode: true in: query name: name__ic schema: items: type: string type: array style: form - explode: true in: query name: name__ie schema: items: type: string type: array style: form - explode: true in: query name: name__iew schema: items: type: string type: array style: form - explode: true in: query name: name__ire schema: items: type: string type: array style: form - explode: true in: query name: name__isw schema: items: type: string type: array style: form - explode: true in: query name: name__n schema: items: type: string type: array style: form - explode: true in: query name: name__nic schema: items: type: string type: array style: form - explode: true in: query name: name__nie schema: items: type: string type: array style: form - explode: true in: query name: name__niew schema: items: type: string type: array style: form - explode: true in: query name: name__nire schema: items: type: string type: array style: form - explode: true in: query name: name__nisw schema: items: type: string type: array style: form - explode: true in: query name: name__nre schema: items: type: string type: array style: form - explode: true in: query name: name__re schema: items: type: string type: array style: form - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Parent interface (name or ID) explode: true in: query name: parent_interface schema: items: format: uuid type: string type: array style: form - description: Parent interface (name or ID) explode: true in: query name: parent_interface__n schema: items: format: uuid type: string type: array style: form - description: Search in: query name: q schema: type: string - explode: true in: query name: status schema: items: format: uuid type: string type: array style: form - explode: true in: query name: status__n schema: items: format: uuid type: string type: array style: form - explode: true in: query name: tag schema: items: type: string type: array style: form - explode: true in: query name: tag__n schema: items: type: string type: array style: form - description: Tagged VLANs (VID or ID) explode: true in: query name: tagged_vlans schema: items: format: uuid type: string type: array style: form - description: Tagged VLANs (VID or ID) explode: true in: query name: tagged_vlans__n schema: items: format: uuid type: string type: array style: form - description: Untagged VLAN (VID or ID) explode: true in: query name: untagged_vlan schema: items: format: uuid type: string type: array style: form - description: Untagged VLAN (VID or ID) explode: true in: query name: untagged_vlan__n schema: items: format: uuid type: string type: array style: form - description: Virtual machine explode: true in: query name: virtual_machine schema: items: type: string type: array style: form - description: Virtual machine explode: true in: query name: virtual_machine__n schema: items: type: string type: array style: form - description: Virtual machine (ID) explode: true in: query name: virtual_machine_id schema: items: format: uuid type: string type: array style: form - description: Virtual machine (ID) explode: true in: query name: virtual_machine_id__n schema: items: format: uuid type: string type: array style: form responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVMInterfaceSerializerVersion12List' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVMInterfaceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVMInterfaceRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVMInterfaceRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/interfaces/{id}/: delete: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_destroy parameters: - description: A UUID string identifying this VM interface. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_retrieve parameters: - description: A UUID string identifying this VM interface. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_partial_update parameters: - description: A UUID string identifying this VM interface. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVMInterfaceRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: Mixin to set `metadata_class` to implement `status` field in model viewset metadata. operationId: virtualization_interfaces_update parameters: - description: A UUID string identifying this VM interface. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVMInterfaceRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VMInterfaceSerializerVersion12' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/interfaces/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: virtualization_interfaces_notes_list parameters: - description: A UUID string identifying this VM interface. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: API methods for returning or creating notes on an object. operationId: virtualization_interfaces_notes_create parameters: - description: A UUID string identifying this VM interface. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/virtual-machines/: delete: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_bulk_destroy requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkOperationRequest' type: array required: true responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_list parameters: - description: cluster in: query name: cluster required: false schema: type: string - description: cluster__n in: query name: cluster__n required: false schema: type: string - description: Cluster group (slug) in: query name: cluster_group required: false schema: type: string - description: Cluster group (slug) in: query name: cluster_group__n required: false schema: type: string - description: Cluster group (ID) in: query name: cluster_group_id required: false schema: type: string - description: Cluster group (ID) in: query name: cluster_group_id__n required: false schema: type: string - description: Cluster (ID) in: query name: cluster_id required: false schema: type: string - description: Cluster (ID) in: query name: cluster_id__n required: false schema: type: string - description: Cluster type (slug) in: query name: cluster_type required: false schema: type: string - description: Cluster type (slug) in: query name: cluster_type__n required: false schema: type: string - description: Cluster type (ID) in: query name: cluster_type_id required: false schema: type: string - description: Cluster type (ID) in: query name: cluster_type_id__n required: false schema: type: string - description: comments in: query name: comments required: false schema: type: string - description: comments__ic in: query name: comments__ic required: false schema: type: string - description: comments__ie in: query name: comments__ie required: false schema: type: string - description: comments__iew in: query name: comments__iew required: false schema: type: string - description: comments__ire in: query name: comments__ire required: false schema: type: string - description: comments__isw in: query name: comments__isw required: false schema: type: string - description: comments__n in: query name: comments__n required: false schema: type: string - description: comments__nic in: query name: comments__nic required: false schema: type: string - description: comments__nie in: query name: comments__nie required: false schema: type: string - description: comments__niew in: query name: comments__niew required: false schema: type: string - description: comments__nire in: query name: comments__nire required: false schema: type: string - description: comments__nisw in: query name: comments__nisw required: false schema: type: string - description: comments__nre in: query name: comments__nre required: false schema: type: string - description: comments__re in: query name: comments__re required: false schema: type: string - description: created in: query name: created required: false schema: type: string - description: created__gte in: query name: created__gte required: false schema: type: string - description: created__lte in: query name: created__lte required: false schema: type: string - description: disk in: query name: disk required: false schema: type: string - description: disk__gt in: query name: disk__gt required: false schema: type: string - description: disk__gte in: query name: disk__gte required: false schema: type: string - description: disk__lt in: query name: disk__lt required: false schema: type: string - description: disk__lte in: query name: disk__lte required: false schema: type: string - description: disk__n in: query name: disk__n required: false schema: type: string - description: Has interfaces in: query name: has_interfaces required: false schema: type: string - description: Has a primary IP in: query name: has_primary_ip required: false schema: type: string - description: Has services in: query name: has_services required: false schema: type: string - description: id in: query name: id required: false schema: type: string - description: id__ic in: query name: id__ic required: false schema: type: string - description: id__ie in: query name: id__ie required: false schema: type: string - description: id__iew in: query name: id__iew required: false schema: type: string - description: id__ire in: query name: id__ire required: false schema: type: string - description: id__isw in: query name: id__isw required: false schema: type: string - description: id__n in: query name: id__n required: false schema: type: string - description: id__nic in: query name: id__nic required: false schema: type: string - description: id__nie in: query name: id__nie required: false schema: type: string - description: id__niew in: query name: id__niew required: false schema: type: string - description: id__nire in: query name: id__nire required: false schema: type: string - description: id__nisw in: query name: id__nisw required: false schema: type: string - description: id__nre in: query name: id__nre required: false schema: type: string - description: id__re in: query name: id__re required: false schema: type: string - description: Interfaces (name or ID) in: query name: interfaces required: false schema: type: string - description: Interfaces (name or ID) in: query name: interfaces__n required: false schema: type: string - description: last_updated in: query name: last_updated required: false schema: type: string - description: last_updated__gte in: query name: last_updated__gte required: false schema: type: string - description: last_updated__lte in: query name: last_updated__lte required: false schema: type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: Has local config context data in: query name: local_context_data required: false schema: type: string - description: Schema (slug) in: query name: local_context_schema required: false schema: type: string - description: Schema (slug) in: query name: local_context_schema__n required: false schema: type: string - description: Schema (ID) in: query name: local_context_schema_id required: false schema: type: string - description: Schema (ID) in: query name: local_context_schema_id__n required: false schema: type: string - description: Location (slug or ID) in: query name: location required: false schema: type: string - description: Location (slug or ID) in: query name: location__n required: false schema: type: string - description: MAC address in: query name: mac_address required: false schema: type: string - description: MAC address in: query name: mac_address__ic required: false schema: type: string - description: MAC address in: query name: mac_address__ie required: false schema: type: string - description: MAC address in: query name: mac_address__iew required: false schema: type: string - description: MAC address in: query name: mac_address__ire required: false schema: type: string - description: MAC address in: query name: mac_address__isw required: false schema: type: string - description: MAC address in: query name: mac_address__n required: false schema: type: string - description: MAC address in: query name: mac_address__nic required: false schema: type: string - description: MAC address in: query name: mac_address__nie required: false schema: type: string - description: MAC address in: query name: mac_address__niew required: false schema: type: string - description: MAC address in: query name: mac_address__nire required: false schema: type: string - description: MAC address in: query name: mac_address__nisw required: false schema: type: string - description: MAC address in: query name: mac_address__nre required: false schema: type: string - description: MAC address in: query name: mac_address__re required: false schema: type: string - description: memory in: query name: memory required: false schema: type: string - description: memory__gt in: query name: memory__gt required: false schema: type: string - description: memory__gte in: query name: memory__gte required: false schema: type: string - description: memory__lt in: query name: memory__lt required: false schema: type: string - description: memory__lte in: query name: memory__lte required: false schema: type: string - description: memory__n in: query name: memory__n required: false schema: type: string - description: name in: query name: name required: false schema: type: string - description: name__ic in: query name: name__ic required: false schema: type: string - description: name__ie in: query name: name__ie required: false schema: type: string - description: name__iew in: query name: name__iew required: false schema: type: string - description: name__ire in: query name: name__ire required: false schema: type: string - description: name__isw in: query name: name__isw required: false schema: type: string - description: name__n in: query name: name__n required: false schema: type: string - description: name__nic in: query name: name__nic required: false schema: type: string - description: name__nie in: query name: name__nie required: false schema: type: string - description: name__niew in: query name: name__niew required: false schema: type: string - description: name__nire in: query name: name__nire required: false schema: type: string - description: name__nisw in: query name: name__nisw required: false schema: type: string - description: name__nre in: query name: name__nre required: false schema: type: string - description: name__re in: query name: name__re required: false schema: type: string - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer - description: Platform (slug) in: query name: platform required: false schema: type: string - description: Platform (slug) in: query name: platform__n required: false schema: type: string - description: Platform (ID) in: query name: platform_id required: false schema: type: string - description: Platform (ID) in: query name: platform_id__n required: false schema: type: string - description: Primary IPv4 Address (address or ID) in: query name: primary_ip4 required: false schema: type: string - description: Primary IPv6 Address (address or ID) in: query name: primary_ip6 required: false schema: type: string - description: Search in: query name: q required: false schema: type: string - description: Region (slug) in: query name: region required: false schema: type: string - description: Region (slug) in: query name: region__n required: false schema: type: string - description: Region (ID) in: query name: region_id required: false schema: type: string - description: Region (ID) in: query name: region_id__n required: false schema: type: string - description: Role (slug) in: query name: role required: false schema: type: string - description: Role (slug) in: query name: role__n required: false schema: type: string - description: Role (ID) in: query name: role_id required: false schema: type: string - description: Role (ID) in: query name: role_id__n required: false schema: type: string - description: Services (name or ID) in: query name: services required: false schema: type: string - description: Services (name or ID) in: query name: services__n required: false schema: type: string - description: Site (slug) in: query name: site required: false schema: type: string - description: Site (slug) in: query name: site__n required: false schema: type: string - description: Site (ID) in: query name: site_id required: false schema: type: string - description: Site (ID) in: query name: site_id__n required: false schema: type: string - description: status in: query name: status required: false schema: type: string - description: status__n in: query name: status__n required: false schema: type: string - description: tag in: query name: tag required: false schema: type: string - description: tag__n in: query name: tag__n required: false schema: type: string - description: Tenant (slug or ID) in: query name: tenant required: false schema: type: string - description: Tenant (slug or ID) in: query name: tenant__n required: false schema: type: string - description: Tenant Group (slug) in: query name: tenant_group required: false schema: type: string - description: Tenant Group (slug) in: query name: tenant_group__n required: false schema: type: string - description: Tenant Group (ID) in: query name: tenant_group_id required: false schema: type: string - description: Tenant Group (ID) in: query name: tenant_group_id__n required: false schema: type: string - description: Tenant (ID) (deprecated, use "tenant" filter instead) in: query name: tenant_id required: false schema: type: string - description: Tenant (ID) (deprecated, use "tenant" filter instead) in: query name: tenant_id__n required: false schema: type: string - description: vcpus in: query name: vcpus required: false schema: type: string - description: vcpus__gt in: query name: vcpus__gt required: false schema: type: string - description: vcpus__gte in: query name: vcpus__gte required: false schema: type: string - description: vcpus__lt in: query name: vcpus__lt required: false schema: type: string - description: vcpus__lte in: query name: vcpus__lte required: false schema: type: string - description: vcpus__n in: query name: vcpus__n required: false schema: type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedVirtualMachineWithConfigContextList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_bulk_partial_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/PatchedBulkWritableVirtualMachineWithConfigContextRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VirtualMachineWithConfigContext' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_create requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_bulk_update requestBody: content: application/json: schema: items: $ref: '#/components/schemas/BulkWritableVirtualMachineWithConfigContextRequest' type: array required: true responses: '200': content: application/json; version=1.3: schema: items: $ref: '#/components/schemas/VirtualMachineWithConfigContext' type: array description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/virtual-machines/{id}/: delete: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_destroy parameters: - description: A UUID string identifying this virtual machine. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No response body security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization get: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_retrieve parameters: - description: A UUID string identifying this virtual machine. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization patch: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_partial_update parameters: - description: A UUID string identifying this virtual machine. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVirtualMachineWithConfigContextRequest' responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization put: description: 'Used by views that work with config context models (device and virtual machine). Provides a get_queryset() method which deals with adding the config context data annotation or not.' operationId: virtualization_virtual_machines_update parameters: - description: A UUID string identifying this virtual machine. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVirtualMachineWithConfigContextRequest' required: true responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/VirtualMachineWithConfigContext' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization /virtualization/virtual-machines/{id}/notes/: get: description: API methods for returning or creating notes on an object. operationId: virtualization_virtual_machines_notes_list parameters: - description: A UUID string identifying this virtual machine. in: path name: id required: true schema: format: uuid type: string - description: Number of results to return per page. in: query name: limit required: false schema: type: integer - description: The initial index from which to return the results. in: query name: offset required: false schema: type: integer responses: '200': content: application/json; version=1.3: schema: $ref: '#/components/schemas/PaginatedNoteList' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization post: description: API methods for returning or creating notes on an object. operationId: virtualization_virtual_machines_notes_create parameters: - description: A UUID string identifying this virtual machine. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteInputRequest' required: true responses: '201': content: application/json; version=1.3: schema: $ref: '#/components/schemas/Note' description: '' security: - cookieAuth: [] - tokenAuth: [] tags: - virtualization servers: - url: /api