openapi: 3.0.3 info: title: NetBox REST authentication-check ipam API version: 4.5.9 (4.5) license: name: Apache v2 License servers: - url: '' description: NetBox tags: - name: ipam paths: /api/ipam/aggregates/: get: operationId: ipam_aggregates_list description: Get a list of aggregate objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: date_added schema: type: array items: type: string format: date explode: true style: form - in: query name: date_added__empty schema: type: boolean - in: query name: date_added__gt schema: type: array items: type: string format: date explode: true style: form - in: query name: date_added__gte schema: type: array items: type: string format: date explode: true style: form - in: query name: date_added__lt schema: type: array items: type: string format: date explode: true style: form - in: query name: date_added__lte schema: type: array items: type: string format: date explode: true style: form - in: query name: date_added__n schema: type: array items: type: string format: date explode: true style: form - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: family schema: type: number - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: prefix schema: type: string description: Prefix - in: query name: q schema: type: string description: Search - in: query name: rir schema: type: array items: type: string description: RIR (slug) explode: true style: form - in: query name: rir__n schema: type: array items: type: string description: RIR (slug) explode: true style: form - in: query name: rir_id schema: type: array items: type: integer description: RIR (ID) explode: true style: form - in: query name: rir_id__n schema: type: array items: type: integer description: RIR (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAggregateList' description: '' post: operationId: ipam_aggregates_create description: Post a list of aggregate objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableAggregateRequest' - type: array items: $ref: '#/components/schemas/WritableAggregateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableAggregateRequest' - type: array items: $ref: '#/components/schemas/WritableAggregateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Aggregate' description: '' put: operationId: ipam_aggregates_bulk_update description: Put a list of aggregate objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AggregateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AggregateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Aggregate' description: '' patch: operationId: ipam_aggregates_bulk_partial_update description: Patch a list of aggregate objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AggregateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AggregateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Aggregate' description: '' delete: operationId: ipam_aggregates_bulk_destroy description: Delete a list of aggregate objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AggregateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AggregateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/aggregates/{id}/: get: operationId: ipam_aggregates_retrieve description: Get a aggregate object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this aggregate. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Aggregate' description: '' put: operationId: ipam_aggregates_update description: Put a aggregate object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this aggregate. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableAggregateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableAggregateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Aggregate' description: '' patch: operationId: ipam_aggregates_partial_update description: Patch a aggregate object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this aggregate. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableAggregateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableAggregateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Aggregate' description: '' delete: operationId: ipam_aggregates_destroy description: Delete a aggregate object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this aggregate. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/asn-ranges/: get: operationId: ipam_asn_ranges_list description: Get a list of ASN range objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: end schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: end__empty schema: type: boolean - in: query name: end__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: end__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: end__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: end__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: end__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rir schema: type: array items: type: string description: RIR (slug) explode: true style: form - in: query name: rir__n schema: type: array items: type: string description: RIR (slug) explode: true style: form - in: query name: rir_id schema: type: array items: type: integer description: RIR (ID) explode: true style: form - in: query name: rir_id__n schema: type: array items: type: integer description: RIR (ID) explode: true style: form - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: start schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: start__empty schema: type: boolean - in: query name: start__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: start__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: start__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: start__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: start__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedASNRangeList' description: '' post: operationId: ipam_asn_ranges_create description: Post a list of ASN range objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ASNRangeRequest' - type: array items: $ref: '#/components/schemas/ASNRangeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ASNRangeRequest' - type: array items: $ref: '#/components/schemas/ASNRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ASNRange' description: '' put: operationId: ipam_asn_ranges_bulk_update description: Put a list of ASN range objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRangeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRange' description: '' patch: operationId: ipam_asn_ranges_bulk_partial_update description: Patch a list of ASN range objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRangeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRange' description: '' delete: operationId: ipam_asn_ranges_bulk_destroy description: Delete a list of ASN range objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRangeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/asn-ranges/{id}/: get: operationId: ipam_asn_ranges_retrieve description: Get a ASN range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN range. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ASNRange' description: '' put: operationId: ipam_asn_ranges_update description: Put a ASN range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN range. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/ASNRangeRequest' multipart/form-data: schema: $ref: '#/components/schemas/ASNRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ASNRange' description: '' patch: operationId: ipam_asn_ranges_partial_update description: Patch a ASN range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN range. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedASNRangeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedASNRangeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ASNRange' description: '' delete: operationId: ipam_asn_ranges_destroy description: Delete a ASN range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN range. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/asn-ranges/{id}/available-asns/: get: operationId: ipam_asn_ranges_available_asns_list description: Get a ASN object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableASN' description: '' post: operationId: ipam_asn_ranges_available_asns_create description: Post a ASN object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/ASN' description: '' /api/ipam/asns/: get: operationId: ipam_asns_list description: Get a list of ASN objects. parameters: - in: query name: asn schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: asn__empty schema: type: boolean - in: query name: asn__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: asn__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: asn__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: asn__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: asn__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: provider schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider__n schema: type: array items: type: string description: Provider (slug) explode: true style: form - in: query name: provider_id schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: provider_id__n schema: type: array items: type: integer description: Provider (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rir schema: type: array items: type: string description: RIR (slug) explode: true style: form - in: query name: rir__n schema: type: array items: type: string description: RIR (slug) explode: true style: form - in: query name: rir_id schema: type: array items: type: integer description: RIR (ID) explode: true style: form - in: query name: rir_id__n schema: type: array items: type: integer description: RIR (ID) explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedASNList' description: '' post: operationId: ipam_asns_create description: Post a list of ASN objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/ASNRequest' - type: array items: $ref: '#/components/schemas/ASNRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/ASNRequest' - type: array items: $ref: '#/components/schemas/ASNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ASN' description: '' put: operationId: ipam_asns_bulk_update description: Put a list of ASN objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ASN' description: '' patch: operationId: ipam_asns_bulk_partial_update description: Patch a list of ASN objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ASN' description: '' delete: operationId: ipam_asns_bulk_destroy description: Delete a list of ASN objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ASNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ASNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/asns/{id}/: get: operationId: ipam_asns_retrieve description: Get a ASN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ASN' description: '' put: operationId: ipam_asns_update description: Put a ASN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/ASNRequest' multipart/form-data: schema: $ref: '#/components/schemas/ASNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ASN' description: '' patch: operationId: ipam_asns_partial_update description: Patch a ASN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedASNRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedASNRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ASN' description: '' delete: operationId: ipam_asns_destroy description: Delete a ASN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this ASN. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/fhrp-group-assignments/: get: operationId: ipam_fhrp_group_assignments_list description: Get a list of FHRP group assignment objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: device schema: type: array items: type: string explode: true style: form - in: query name: device_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: group_id schema: type: array items: type: integer description: Group (ID) explode: true style: form - in: query name: group_id__n schema: type: array items: type: integer description: Group (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id__empty schema: type: boolean - in: query name: interface_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_type schema: type: array items: type: string explode: true style: form - in: query name: interface_type__n schema: type: array items: type: string explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: priority schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: priority__empty schema: type: boolean - in: query name: priority__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: priority__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: priority__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: priority__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: priority__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_machine schema: type: array items: type: string explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer format: int32 explode: true style: form tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFHRPGroupAssignmentList' description: '' post: operationId: ipam_fhrp_group_assignments_create description: Post a list of FHRP group assignment objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/FHRPGroupAssignmentRequest' - type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/FHRPGroupAssignmentRequest' - type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FHRPGroupAssignment' description: '' put: operationId: ipam_fhrp_group_assignments_bulk_update description: Put a list of FHRP group assignment objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignment' description: '' patch: operationId: ipam_fhrp_group_assignments_bulk_partial_update description: Patch a list of FHRP group assignment objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignment' description: '' delete: operationId: ipam_fhrp_group_assignments_bulk_destroy description: Delete a list of FHRP group assignment objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/fhrp-group-assignments/{id}/: get: operationId: ipam_fhrp_group_assignments_retrieve description: Get a FHRP group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group assignment. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FHRPGroupAssignment' description: '' put: operationId: ipam_fhrp_group_assignments_update description: Put a FHRP group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group assignment. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' multipart/form-data: schema: $ref: '#/components/schemas/FHRPGroupAssignmentRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FHRPGroupAssignment' description: '' patch: operationId: ipam_fhrp_group_assignments_partial_update description: Patch a FHRP group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group assignment. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFHRPGroupAssignmentRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFHRPGroupAssignmentRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FHRPGroupAssignment' description: '' delete: operationId: ipam_fhrp_group_assignments_destroy description: Delete a FHRP group assignment object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group assignment. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/fhrp-groups/: get: operationId: ipam_fhrp_groups_list description: Get a list of FHRP group objects. parameters: - in: query name: auth_key schema: type: array items: type: string explode: true style: form - in: query name: auth_key__empty schema: type: boolean - in: query name: auth_key__ic schema: type: array items: type: string explode: true style: form - in: query name: auth_key__ie schema: type: array items: type: string explode: true style: form - in: query name: auth_key__iew schema: type: array items: type: string explode: true style: form - in: query name: auth_key__iregex schema: type: array items: type: string explode: true style: form - in: query name: auth_key__isw schema: type: array items: type: string explode: true style: form - in: query name: auth_key__n schema: type: array items: type: string explode: true style: form - in: query name: auth_key__nic schema: type: array items: type: string explode: true style: form - in: query name: auth_key__nie schema: type: array items: type: string explode: true style: form - in: query name: auth_key__niew schema: type: array items: type: string explode: true style: form - in: query name: auth_key__nisw schema: type: array items: type: string explode: true style: form - in: query name: auth_key__regex schema: type: array items: type: string explode: true style: form - in: query name: auth_type schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__empty schema: type: boolean - in: query name: auth_type__ic schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__ie schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__iew schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__iregex schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__isw schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__n schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__nic schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__nie schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__niew schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__nisw schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: auth_type__regex schema: type: array items: type: string x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: group_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: group_id__empty schema: type: boolean - in: query name: group_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: group_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: group_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: group_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: group_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: protocol schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__empty schema: type: boolean - in: query name: protocol__ic schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__ie schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__iew schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__iregex schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__isw schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__n schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__nic schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__nie schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__niew schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__nisw schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: protocol__regex schema: type: array items: type: string x-spec-enum-id: 98de93c9f65d1c65 explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: related_ip schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedFHRPGroupList' description: '' post: operationId: ipam_fhrp_groups_create description: Post a list of FHRP group objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/FHRPGroupRequest' - type: array items: $ref: '#/components/schemas/FHRPGroupRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/FHRPGroupRequest' - type: array items: $ref: '#/components/schemas/FHRPGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/FHRPGroup' description: '' put: operationId: ipam_fhrp_groups_bulk_update description: Put a list of FHRP group objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FHRPGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroup' description: '' patch: operationId: ipam_fhrp_groups_bulk_partial_update description: Patch a list of FHRP group objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FHRPGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroup' description: '' delete: operationId: ipam_fhrp_groups_bulk_destroy description: Delete a list of FHRP group objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/FHRPGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/FHRPGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/fhrp-groups/{id}/: get: operationId: ipam_fhrp_groups_retrieve description: Get a FHRP group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FHRPGroup' description: '' put: operationId: ipam_fhrp_groups_update description: Put a FHRP group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/FHRPGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/FHRPGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FHRPGroup' description: '' patch: operationId: ipam_fhrp_groups_partial_update description: Patch a FHRP group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedFHRPGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedFHRPGroupRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FHRPGroup' description: '' delete: operationId: ipam_fhrp_groups_destroy description: Delete a FHRP group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this FHRP group. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/ip-addresses/: get: operationId: ipam_ip_addresses_list description: Get a list of IP address objects. parameters: - in: query name: address schema: type: array items: type: string explode: true style: form - in: query name: assigned schema: type: boolean description: Is assigned - in: query name: assigned_object_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__empty schema: type: boolean - in: query name: assigned_object_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_type schema: type: array items: type: string explode: true style: form - in: query name: assigned_object_type__n schema: type: array items: type: string explode: true style: form - in: query name: assigned_to_interface schema: type: boolean description: Is assigned to an interface - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string explode: true style: form - in: query name: device_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: dns_name schema: type: array items: type: string explode: true style: form - in: query name: dns_name__empty schema: type: boolean - in: query name: dns_name__ic schema: type: array items: type: string explode: true style: form - in: query name: dns_name__ie schema: type: array items: type: string explode: true style: form - in: query name: dns_name__iew schema: type: array items: type: string explode: true style: form - in: query name: dns_name__iregex schema: type: array items: type: string explode: true style: form - in: query name: dns_name__isw schema: type: array items: type: string explode: true style: form - in: query name: dns_name__n schema: type: array items: type: string explode: true style: form - in: query name: dns_name__nic schema: type: array items: type: string explode: true style: form - in: query name: dns_name__nie schema: type: array items: type: string explode: true style: form - in: query name: dns_name__niew schema: type: array items: type: string explode: true style: form - in: query name: dns_name__nisw schema: type: array items: type: string explode: true style: form - in: query name: dns_name__regex schema: type: array items: type: string explode: true style: form - in: query name: family schema: type: number - in: query name: fhrpgroup_id schema: type: array items: type: integer description: FHRP group (ID) explode: true style: form - in: query name: fhrpgroup_id__n schema: type: array items: type: integer description: FHRP group (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface__n schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface_id schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: mask_length schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mask_length__gte schema: type: number - in: query name: mask_length__lte schema: type: number - in: query name: modified_by_request schema: type: string format: uuid - in: query name: nat_inside_id schema: type: array items: type: integer description: NAT inside IP address (ID) explode: true style: form - in: query name: nat_inside_id__n schema: type: array items: type: integer description: NAT inside IP address (ID) explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string explode: true style: form - in: query name: present_in_vrf schema: type: string - in: query name: present_in_vrf_id schema: type: string - in: query name: q schema: type: string description: Search - in: query name: role schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__empty schema: type: boolean - in: query name: role__ic schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__ie schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__iew schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__iregex schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__isw schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__n schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__nic schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__nie schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__niew schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__nisw schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: role__regex schema: type: array items: type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: The functional role of this IP explode: true style: form - in: query name: service_id schema: type: array items: type: integer description: Application Service (ID) explode: true style: form - in: query name: service_id__n schema: type: array items: type: integer description: Application Service (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: c421c4c4a0fa7a2a description: The operational status of this IP explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_machine schema: type: array items: type: string explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vminterface schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface__n schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface_id schema: type: array items: type: integer description: VM interface (ID) explode: true style: form - in: query name: vminterface_id__n schema: type: array items: type: integer description: VM interface (ID) explode: true style: form - in: query name: vrf schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf__n schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf_id schema: type: array items: type: integer nullable: true description: VRF explode: true style: form - in: query name: vrf_id__n schema: type: array items: type: integer nullable: true description: VRF explode: true style: form tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedIPAddressList' description: '' post: operationId: ipam_ip_addresses_create description: Post a list of IP address objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableIPAddressRequest' - type: array items: $ref: '#/components/schemas/WritableIPAddressRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableIPAddressRequest' - type: array items: $ref: '#/components/schemas/WritableIPAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IPAddress' description: '' put: operationId: ipam_ip_addresses_bulk_update description: Put a list of IP address objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddressRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddress' description: '' patch: operationId: ipam_ip_addresses_bulk_partial_update description: Patch a list of IP address objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddressRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddress' description: '' delete: operationId: ipam_ip_addresses_bulk_destroy description: Delete a list of IP address objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddressRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/ip-addresses/{id}/: get: operationId: ipam_ip_addresses_retrieve description: Get a IP address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP address. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPAddress' description: '' put: operationId: ipam_ip_addresses_update description: Put a IP address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP address. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPAddressRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableIPAddressRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPAddress' description: '' patch: operationId: ipam_ip_addresses_partial_update description: Patch a IP address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP address. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIPAddressRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableIPAddressRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPAddress' description: '' delete: operationId: ipam_ip_addresses_destroy description: Delete a IP address object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP address. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/ip-ranges/: get: operationId: ipam_ip_ranges_list description: Get a list of IP range objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contains schema: type: string description: Ranges which contain this prefix or IP - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: end_address schema: type: array items: type: string explode: true style: form - in: query name: family schema: type: number - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: mark_populated schema: type: boolean - in: query name: mark_utilized schema: type: boolean - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: role schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role__n schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role_id schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: role_id__n schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: size schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__empty schema: type: boolean - in: query name: size__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: size__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: start_address schema: type: array items: type: string explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this range explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vrf schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf__n schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf_id schema: type: array items: type: integer nullable: true description: VRF explode: true style: form - in: query name: vrf_id__n schema: type: array items: type: integer nullable: true description: VRF explode: true style: form tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedIPRangeList' description: '' post: operationId: ipam_ip_ranges_create description: Post a list of IP range objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableIPRangeRequest' - type: array items: $ref: '#/components/schemas/WritableIPRangeRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableIPRangeRequest' - type: array items: $ref: '#/components/schemas/WritableIPRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IPRange' description: '' put: operationId: ipam_ip_ranges_bulk_update description: Put a list of IP range objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPRangeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPRange' description: '' patch: operationId: ipam_ip_ranges_bulk_partial_update description: Patch a list of IP range objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPRangeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPRange' description: '' delete: operationId: ipam_ip_ranges_bulk_destroy description: Delete a list of IP range objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPRangeRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/ip-ranges/{id}/: get: operationId: ipam_ip_ranges_retrieve description: Get a IP range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP range. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPRange' description: '' put: operationId: ipam_ip_ranges_update description: Put a IP range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP range. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPRangeRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableIPRangeRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPRange' description: '' patch: operationId: ipam_ip_ranges_partial_update description: Patch a IP range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP range. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIPRangeRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableIPRangeRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPRange' description: '' delete: operationId: ipam_ip_ranges_destroy description: Delete a IP range object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IP range. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/ip-ranges/{id}/available-ips/: get: operationId: ipam_ip_ranges_available_ips_list description: Get a IP address object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableIP' description: '' post: operationId: ipam_ip_ranges_available_ips_create description: Post a IP address object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableIPRequestRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AvailableIPRequestRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddress' description: '' /api/ipam/prefixes/: get: operationId: ipam_prefixes_list description: Get a list of prefix objects. parameters: - in: query name: children schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: children__empty schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: children__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: children__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: children__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: children__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: children__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contains schema: type: string description: Prefixes which contain this prefix or IP - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: depth schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: depth__empty schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: depth__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: depth__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: depth__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: depth__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: depth__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: family schema: type: number - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: is_pool schema: type: boolean - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: array items: type: string explode: true style: form - in: query name: location__n schema: type: array items: type: string explode: true style: form - in: query name: location_id schema: type: array items: type: string explode: true style: form - in: query name: location_id__n schema: type: array items: type: string explode: true style: form - in: query name: mark_utilized schema: type: boolean - in: query name: mask_length schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: mask_length__gte schema: type: number - in: query name: mask_length__lte schema: type: number - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: prefix schema: type: array items: type: string explode: true style: form - in: query name: present_in_vrf schema: type: string - in: query name: present_in_vrf_id schema: type: string - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: role schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role__n schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role_id schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: role_id__n schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: scope_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__empty schema: type: boolean - in: query name: scope_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_type schema: type: array items: type: string explode: true style: form - in: query name: scope_type__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 026173ce39f2ee63 description: Operational status of this prefix explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vlan_group schema: type: array items: type: string description: VLAN Group (slug) explode: true style: form - in: query name: vlan_group__n schema: type: array items: type: string description: VLAN Group (slug) explode: true style: form - in: query name: vlan_group_id schema: type: array items: type: integer description: VLAN Group (ID) explode: true style: form - in: query name: vlan_group_id__n schema: type: array items: type: integer description: VLAN Group (ID) explode: true style: form - in: query name: vlan_id schema: type: array items: type: integer nullable: true description: VLAN (ID) explode: true style: form - in: query name: vlan_id__n schema: type: array items: type: integer nullable: true description: VLAN (ID) explode: true style: form - in: query name: vlan_vid schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__empty schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__gt schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__gte schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__lt schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__lte schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__n schema: type: integer description: VLAN number (1-4094) - in: query name: vrf schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf__n schema: type: array items: type: string nullable: true title: Route distinguisher description: VRF (RD) explode: true style: form - in: query name: vrf_id schema: type: array items: type: integer nullable: true description: VRF explode: true style: form - in: query name: vrf_id__n schema: type: array items: type: integer nullable: true description: VRF explode: true style: form - in: query name: within schema: type: string description: Within prefix - in: query name: within_include schema: type: string description: Within and including prefix tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPrefixList' description: '' post: operationId: ipam_prefixes_create description: Post a list of prefix objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritablePrefixRequest' - type: array items: $ref: '#/components/schemas/WritablePrefixRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritablePrefixRequest' - type: array items: $ref: '#/components/schemas/WritablePrefixRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Prefix' description: '' put: operationId: ipam_prefixes_bulk_update description: Put a list of prefix objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PrefixRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PrefixRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Prefix' description: '' patch: operationId: ipam_prefixes_bulk_partial_update description: Patch a list of prefix objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PrefixRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PrefixRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Prefix' description: '' delete: operationId: ipam_prefixes_bulk_destroy description: Delete a list of prefix objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PrefixRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PrefixRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/prefixes/{id}/: get: operationId: ipam_prefixes_retrieve description: Get a prefix object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prefix. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Prefix' description: '' put: operationId: ipam_prefixes_update description: Put a prefix object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prefix. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritablePrefixRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritablePrefixRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Prefix' description: '' patch: operationId: ipam_prefixes_partial_update description: Patch a prefix object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prefix. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritablePrefixRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritablePrefixRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Prefix' description: '' delete: operationId: ipam_prefixes_destroy description: Delete a prefix object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this prefix. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/prefixes/{id}/available-ips/: get: operationId: ipam_prefixes_available_ips_list description: Get a IP address object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableIP' description: '' post: operationId: ipam_prefixes_available_ips_create description: Post a IP address object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableIPRequestRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/AvailableIPRequestRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPAddress' description: '' /api/ipam/prefixes/{id}/available-prefixes/: get: operationId: ipam_prefixes_available_prefixes_list description: Get a prefix object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailablePrefix' description: '' post: operationId: ipam_prefixes_available_prefixes_create description: Post a prefix object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PrefixLengthRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/PrefixLengthRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/Prefix' description: '' /api/ipam/rirs/: get: operationId: ipam_rirs_list description: Get a list of RIR objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: is_private schema: type: boolean - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRIRList' description: '' post: operationId: ipam_rirs_create description: Post a list of RIR objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/RIRRequest' - type: array items: $ref: '#/components/schemas/RIRRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/RIRRequest' - type: array items: $ref: '#/components/schemas/RIRRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RIR' description: '' put: operationId: ipam_rirs_bulk_update description: Put a list of RIR objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RIRRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RIRRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RIR' description: '' patch: operationId: ipam_rirs_bulk_partial_update description: Patch a list of RIR objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RIRRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RIRRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RIR' description: '' delete: operationId: ipam_rirs_bulk_destroy description: Delete a list of RIR objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RIRRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RIRRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/rirs/{id}/: get: operationId: ipam_rirs_retrieve description: Get a RIR object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this RIR. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RIR' description: '' put: operationId: ipam_rirs_update description: Put a RIR object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this RIR. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/RIRRequest' multipart/form-data: schema: $ref: '#/components/schemas/RIRRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RIR' description: '' patch: operationId: ipam_rirs_partial_update description: Patch a RIR object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this RIR. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRIRRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRIRRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RIR' description: '' delete: operationId: ipam_rirs_destroy description: Delete a RIR object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this RIR. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/roles/: get: operationId: ipam_roles_list description: Get a list of role objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: weight schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: weight__empty schema: type: boolean - in: query name: weight__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: weight__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: weight__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: weight__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: weight__n schema: type: array items: type: integer format: int32 explode: true style: form tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRoleList' description: '' post: operationId: ipam_roles_create description: Post a list of role objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/RoleRequest' - type: array items: $ref: '#/components/schemas/RoleRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/RoleRequest' - type: array items: $ref: '#/components/schemas/RoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Role' description: '' put: operationId: ipam_roles_bulk_update description: Put a list of role objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Role' description: '' patch: operationId: ipam_roles_bulk_partial_update description: Patch a list of role objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Role' description: '' delete: operationId: ipam_roles_bulk_destroy description: Delete a list of role objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RoleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/roles/{id}/: get: operationId: ipam_roles_retrieve description: Get a role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this role. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Role' description: '' put: operationId: ipam_roles_update description: Put a role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this role. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/RoleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Role' description: '' patch: operationId: ipam_roles_partial_update description: Patch a role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this role. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRoleRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRoleRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Role' description: '' delete: operationId: ipam_roles_destroy description: Delete a role object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this role. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/route-targets/: get: operationId: ipam_route_targets_list description: Get a list of route target objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: exporting_l2vpn schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: Exporting L2VPN (identifier) explode: true style: form - in: query name: exporting_l2vpn__n schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: Exporting L2VPN (identifier) explode: true style: form - in: query name: exporting_l2vpn_id schema: type: array items: type: integer description: Exporting L2VPN explode: true style: form - in: query name: exporting_l2vpn_id__n schema: type: array items: type: integer description: Exporting L2VPN explode: true style: form - in: query name: exporting_vrf schema: type: array items: type: string nullable: true title: Route distinguisher description: Export VRF (RD) explode: true style: form - in: query name: exporting_vrf__n schema: type: array items: type: string nullable: true title: Route distinguisher description: Export VRF (RD) explode: true style: form - in: query name: exporting_vrf_id schema: type: array items: type: integer description: Exporting VRF explode: true style: form - in: query name: exporting_vrf_id__n schema: type: array items: type: integer description: Exporting VRF explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: importing_l2vpn schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: Importing L2VPN (identifier) explode: true style: form - in: query name: importing_l2vpn__n schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: Importing L2VPN (identifier) explode: true style: form - in: query name: importing_l2vpn_id schema: type: array items: type: integer description: Importing L2VPN explode: true style: form - in: query name: importing_l2vpn_id__n schema: type: array items: type: integer description: Importing L2VPN explode: true style: form - in: query name: importing_vrf schema: type: array items: type: string nullable: true title: Route distinguisher description: Import VRF (RD) explode: true style: form - in: query name: importing_vrf__n schema: type: array items: type: string nullable: true title: Route distinguisher description: Import VRF (RD) explode: true style: form - in: query name: importing_vrf_id schema: type: array items: type: integer description: Importing VRF explode: true style: form - in: query name: importing_vrf_id__n schema: type: array items: type: integer description: Importing VRF explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRouteTargetList' description: '' post: operationId: ipam_route_targets_create description: Post a list of route target objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/RouteTargetRequest' - type: array items: $ref: '#/components/schemas/RouteTargetRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/RouteTargetRequest' - type: array items: $ref: '#/components/schemas/RouteTargetRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/RouteTarget' description: '' put: operationId: ipam_route_targets_bulk_update description: Put a list of route target objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RouteTargetRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RouteTargetRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RouteTarget' description: '' patch: operationId: ipam_route_targets_bulk_partial_update description: Patch a list of route target objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RouteTargetRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RouteTargetRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/RouteTarget' description: '' delete: operationId: ipam_route_targets_bulk_destroy description: Delete a list of route target objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/RouteTargetRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/RouteTargetRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/route-targets/{id}/: get: operationId: ipam_route_targets_retrieve description: Get a route target object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this route target. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RouteTarget' description: '' put: operationId: ipam_route_targets_update description: Put a route target object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this route target. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteTargetRequest' multipart/form-data: schema: $ref: '#/components/schemas/RouteTargetRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RouteTarget' description: '' patch: operationId: ipam_route_targets_partial_update description: Patch a route target object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this route target. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRouteTargetRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedRouteTargetRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/RouteTarget' description: '' delete: operationId: ipam_route_targets_destroy description: Delete a route target object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this route target. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/service-templates/: get: operationId: ipam_service_templates_list description: Get a list of application service template objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: port schema: type: number - in: query name: port__empty schema: type: number - in: query name: port__gt schema: type: number - in: query name: port__gte schema: type: number - in: query name: port__lt schema: type: number - in: query name: port__lte schema: type: number - in: query name: port__n schema: type: number - in: query name: protocol schema: type: string x-spec-enum-id: e4b15bec749a2a32 enum: - 'null' - sctp - tcp - udp description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' - in: query name: protocol__empty schema: type: boolean - in: query name: protocol__ic schema: type: array items: type: string explode: true style: form - in: query name: protocol__ie schema: type: array items: type: string explode: true style: form - in: query name: protocol__iew schema: type: array items: type: string explode: true style: form - in: query name: protocol__iregex schema: type: array items: type: string explode: true style: form - in: query name: protocol__isw schema: type: array items: type: string explode: true style: form - in: query name: protocol__n schema: type: string x-spec-enum-id: e4b15bec749a2a32 enum: - 'null' - sctp - tcp - udp description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' - in: query name: protocol__nic schema: type: array items: type: string explode: true style: form - in: query name: protocol__nie schema: type: array items: type: string explode: true style: form - in: query name: protocol__niew schema: type: array items: type: string explode: true style: form - in: query name: protocol__nisw schema: type: array items: type: string explode: true style: form - in: query name: protocol__regex schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedServiceTemplateList' description: '' post: operationId: ipam_service_templates_create description: Post a list of application service template objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableServiceTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableServiceTemplateRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableServiceTemplateRequest' - type: array items: $ref: '#/components/schemas/WritableServiceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/ServiceTemplate' description: '' put: operationId: ipam_service_templates_bulk_update description: Put a list of application service template objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ServiceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceTemplate' description: '' patch: operationId: ipam_service_templates_bulk_partial_update description: Patch a list of application service template objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ServiceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceTemplate' description: '' delete: operationId: ipam_service_templates_bulk_destroy description: Delete a list of application service template objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceTemplateRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ServiceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/service-templates/{id}/: get: operationId: ipam_service_templates_retrieve description: Get a application service template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service template. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceTemplate' description: '' put: operationId: ipam_service_templates_update description: Put a application service template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service template. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableServiceTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableServiceTemplateRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceTemplate' description: '' patch: operationId: ipam_service_templates_partial_update description: Patch a application service template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service template. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableServiceTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableServiceTemplateRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceTemplate' description: '' delete: operationId: ipam_service_templates_destroy description: Delete a application service template object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service template. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/services/: get: operationId: ipam_services_list description: Get a list of application service objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: device schema: type: array items: type: string explode: true style: form - in: query name: device_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: fhrpgroup schema: type: array items: type: string explode: true style: form - in: query name: fhrpgroup_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: ip_address schema: type: array items: type: string description: IP address explode: true style: form - in: query name: ip_address__n schema: type: array items: type: string description: IP address explode: true style: form - in: query name: ip_address_id schema: type: array items: type: integer description: IP address (ID) explode: true style: form - in: query name: ip_address_id__n schema: type: array items: type: integer description: IP address (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: parent_object_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: parent_object_id__empty schema: type: boolean - in: query name: parent_object_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: parent_object_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: parent_object_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: parent_object_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: parent_object_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: parent_object_type schema: type: array items: type: string explode: true style: form - in: query name: parent_object_type__n schema: type: array items: type: string explode: true style: form - in: query name: port schema: type: number - in: query name: port__empty schema: type: number - in: query name: port__gt schema: type: number - in: query name: port__gte schema: type: number - in: query name: port__lt schema: type: number - in: query name: port__lte schema: type: number - in: query name: port__n schema: type: number - in: query name: protocol schema: type: string x-spec-enum-id: e4b15bec749a2a32 enum: - 'null' - sctp - tcp - udp description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' - in: query name: protocol__empty schema: type: boolean - in: query name: protocol__ic schema: type: array items: type: string explode: true style: form - in: query name: protocol__ie schema: type: array items: type: string explode: true style: form - in: query name: protocol__iew schema: type: array items: type: string explode: true style: form - in: query name: protocol__iregex schema: type: array items: type: string explode: true style: form - in: query name: protocol__isw schema: type: array items: type: string explode: true style: form - in: query name: protocol__n schema: type: string x-spec-enum-id: e4b15bec749a2a32 enum: - 'null' - sctp - tcp - udp description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' - in: query name: protocol__nic schema: type: array items: type: string explode: true style: form - in: query name: protocol__nie schema: type: array items: type: string explode: true style: form - in: query name: protocol__niew schema: type: array items: type: string explode: true style: form - in: query name: protocol__nisw schema: type: array items: type: string explode: true style: form - in: query name: protocol__regex schema: type: array items: type: string explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: virtual_machine schema: type: array items: type: string explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer format: int32 explode: true style: form tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedServiceList' description: '' post: operationId: ipam_services_create description: Post a list of application service objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableServiceRequest' - type: array items: $ref: '#/components/schemas/WritableServiceRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableServiceRequest' - type: array items: $ref: '#/components/schemas/WritableServiceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Service' description: '' put: operationId: ipam_services_bulk_update description: Put a list of application service objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ServiceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Service' description: '' patch: operationId: ipam_services_bulk_partial_update description: Patch a list of application service objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ServiceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Service' description: '' delete: operationId: ipam_services_bulk_destroy description: Delete a list of application service objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/ServiceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/services/{id}/: get: operationId: ipam_services_retrieve description: Get a application service object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Service' description: '' put: operationId: ipam_services_update description: Put a application service object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableServiceRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableServiceRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Service' description: '' patch: operationId: ipam_services_partial_update description: Patch a application service object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableServiceRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableServiceRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Service' description: '' delete: operationId: ipam_services_destroy description: Delete a application service object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this application service. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlan-groups/: get: operationId: ipam_vlan_groups_list description: Get a list of VLAN group objects. parameters: - in: query name: cluster schema: type: integer - in: query name: cluster_group schema: type: integer - in: query name: contains_vid schema: type: number - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: location schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rack schema: type: integer - in: query name: region schema: type: integer - in: query name: scope_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__empty schema: type: boolean - in: query name: scope_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: scope_type schema: type: array items: type: string explode: true style: form - in: query name: scope_type__n schema: type: array items: type: string explode: true style: form - in: query name: site schema: type: integer - in: query name: site_group schema: type: integer - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVLANGroupList' description: '' post: operationId: ipam_vlan_groups_create description: Post a list of VLAN group objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/VLANGroupRequest' - type: array items: $ref: '#/components/schemas/VLANGroupRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/VLANGroupRequest' - type: array items: $ref: '#/components/schemas/VLANGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VLANGroup' description: '' put: operationId: ipam_vlan_groups_bulk_update description: Put a list of VLAN group objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANGroup' description: '' patch: operationId: ipam_vlan_groups_bulk_partial_update description: Patch a list of VLAN group objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANGroup' description: '' delete: operationId: ipam_vlan_groups_bulk_destroy description: Delete a list of VLAN group objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlan-groups/{id}/: get: operationId: ipam_vlan_groups_retrieve description: Get a VLAN group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN group. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANGroup' description: '' put: operationId: ipam_vlan_groups_update description: Put a VLAN group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN group. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/VLANGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/VLANGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANGroup' description: '' patch: operationId: ipam_vlan_groups_partial_update description: Patch a VLAN group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN group. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVLANGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVLANGroupRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANGroup' description: '' delete: operationId: ipam_vlan_groups_destroy description: Delete a VLAN group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN group. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlan-groups/{id}/available-vlans/: get: operationId: ipam_vlan_groups_available_vlans_list description: Get a VLAN object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableVLAN' description: '' post: operationId: ipam_vlan_groups_available_vlans_create description: Post a VLAN object. parameters: - in: path name: id schema: type: integer required: true tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CreateAvailableVLANRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/CreateAvailableVLANRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLAN' description: '' /api/ipam/vlan-translation-policies/: get: operationId: ipam_vlan_translation_policies_list description: Get a list of VLAN translation policy objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVLANTranslationPolicyList' description: '' post: operationId: ipam_vlan_translation_policies_create description: Post a list of VLAN translation policy objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/VLANTranslationPolicyRequest' - type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/VLANTranslationPolicyRequest' - type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationPolicy' description: '' put: operationId: ipam_vlan_translation_policies_bulk_update description: Put a list of VLAN translation policy objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicy' description: '' patch: operationId: ipam_vlan_translation_policies_bulk_partial_update description: Patch a list of VLAN translation policy objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicy' description: '' delete: operationId: ipam_vlan_translation_policies_bulk_destroy description: Delete a list of VLAN translation policy objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANTranslationPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlan-translation-policies/{id}/: get: operationId: ipam_vlan_translation_policies_retrieve description: Get a VLAN translation policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation policy. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationPolicy' description: '' put: operationId: ipam_vlan_translation_policies_update description: Put a VLAN translation policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation policy. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/VLANTranslationPolicyRequest' multipart/form-data: schema: $ref: '#/components/schemas/VLANTranslationPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationPolicy' description: '' patch: operationId: ipam_vlan_translation_policies_partial_update description: Patch a VLAN translation policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation policy. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVLANTranslationPolicyRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVLANTranslationPolicyRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationPolicy' description: '' delete: operationId: ipam_vlan_translation_policies_destroy description: Delete a VLAN translation policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation policy. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlan-translation-rules/: get: operationId: ipam_vlan_translation_rules_list description: Get a list of VLAN translation rule objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: local_vid schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: local_vid__empty schema: type: boolean - in: query name: local_vid__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: local_vid__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: local_vid__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: local_vid__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: local_vid__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: policy schema: type: array items: type: string description: VLAN Translation Policy (name) explode: true style: form - in: query name: policy__n schema: type: array items: type: string description: VLAN Translation Policy (name) explode: true style: form - in: query name: policy_id schema: type: array items: type: integer description: VLAN Translation Policy (ID) explode: true style: form - in: query name: policy_id__n schema: type: array items: type: integer description: VLAN Translation Policy (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: remote_vid schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: remote_vid__empty schema: type: boolean - in: query name: remote_vid__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: remote_vid__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: remote_vid__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: remote_vid__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: remote_vid__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVLANTranslationRuleList' description: '' post: operationId: ipam_vlan_translation_rules_create description: Post a list of VLAN translation rule objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/VLANTranslationRuleRequest' - type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/VLANTranslationRuleRequest' - type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationRule' description: '' put: operationId: ipam_vlan_translation_rules_bulk_update description: Put a list of VLAN translation rule objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRule' description: '' patch: operationId: ipam_vlan_translation_rules_bulk_partial_update description: Patch a list of VLAN translation rule objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRule' description: '' delete: operationId: ipam_vlan_translation_rules_bulk_destroy description: Delete a list of VLAN translation rule objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANTranslationRuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlan-translation-rules/{id}/: get: operationId: ipam_vlan_translation_rules_retrieve description: Get a VLAN translation rule object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation rule. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationRule' description: '' put: operationId: ipam_vlan_translation_rules_update description: Put a VLAN translation rule object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation rule. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/VLANTranslationRuleRequest' multipart/form-data: schema: $ref: '#/components/schemas/VLANTranslationRuleRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationRule' description: '' patch: operationId: ipam_vlan_translation_rules_partial_update description: Patch a VLAN translation rule object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation rule. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVLANTranslationRuleRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVLANTranslationRuleRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLANTranslationRule' description: '' delete: operationId: ipam_vlan_translation_rules_destroy description: Delete a VLAN translation rule object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN translation rule. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlans/: get: operationId: ipam_vlans_list description: Get a list of VLAN objects. parameters: - in: query name: available_at_site schema: type: string - in: query name: available_on_device schema: type: string - in: query name: available_on_virtualmachine schema: type: string - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: group schema: type: array items: type: string description: Group explode: true style: form - in: query name: group__n schema: type: array items: type: string description: Group explode: true style: form - in: query name: group_id schema: type: array items: type: integer nullable: true description: Group (ID) explode: true style: form - in: query name: group_id__n schema: type: array items: type: integer nullable: true description: Group (ID) explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: interface_id schema: type: integer - in: query name: l2vpn schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: L2VPN explode: true style: form - in: query name: l2vpn__n schema: type: array items: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true description: L2VPN explode: true style: form - in: query name: l2vpn_id schema: type: array items: type: integer description: L2VPN (ID) explode: true style: form - in: query name: l2vpn_id__n schema: type: array items: type: integer description: L2VPN (ID) explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: qinq_role schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__empty schema: type: boolean - in: query name: qinq_role__ic schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__ie schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__iew schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__iregex schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__isw schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__n schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__nic schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__nie schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__niew schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__nisw schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_role__regex schema: type: array items: type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) explode: true style: form - in: query name: qinq_svlan_id schema: type: array items: type: integer nullable: true description: Q-in-Q SVLAN (ID) explode: true style: form - in: query name: qinq_svlan_id__n schema: type: array items: type: integer nullable: true description: Q-in-Q SVLAN (ID) explode: true style: form - in: query name: qinq_svlan_vid schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: qinq_svlan_vid__empty schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: qinq_svlan_vid__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: qinq_svlan_vid__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: qinq_svlan_vid__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: qinq_svlan_vid__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: qinq_svlan_vid__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region__n schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: string explode: true style: form - in: query name: region_id__n schema: type: array items: type: string explode: true style: form - in: query name: role schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role__n schema: type: array items: type: string description: Role (slug) explode: true style: form - in: query name: role_id schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: role_id__n schema: type: array items: type: integer nullable: true description: Role (ID) explode: true style: form - in: query name: site schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site__n schema: type: array items: type: string description: Site (slug) explode: true style: form - in: query name: site_group schema: type: array items: type: string explode: true style: form - in: query name: site_group__n schema: type: array items: type: string explode: true style: form - in: query name: site_group_id schema: type: array items: type: string explode: true style: form - in: query name: site_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer nullable: true description: Site (ID) explode: true style: form - in: query name: site_id__n schema: type: array items: type: integer nullable: true description: Site (ID) explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: ca933c38b935e547 description: Operational status of this VLAN explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vid schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vid__empty schema: type: boolean - in: query name: vid__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vid__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vid__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vid__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vid__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: vminterface_id schema: type: integer tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVLANList' description: '' post: operationId: ipam_vlans_create description: Post a list of VLAN objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableVLANRequest' - type: array items: $ref: '#/components/schemas/WritableVLANRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableVLANRequest' - type: array items: $ref: '#/components/schemas/WritableVLANRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VLAN' description: '' put: operationId: ipam_vlans_bulk_update description: Put a list of VLAN objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLAN' description: '' patch: operationId: ipam_vlans_bulk_partial_update description: Patch a list of VLAN objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VLAN' description: '' delete: operationId: ipam_vlans_bulk_destroy description: Delete a list of VLAN objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VLANRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VLANRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vlans/{id}/: get: operationId: ipam_vlans_retrieve description: Get a VLAN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLAN' description: '' put: operationId: ipam_vlans_update description: Put a VLAN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableVLANRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableVLANRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLAN' description: '' patch: operationId: ipam_vlans_partial_update description: Patch a VLAN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableVLANRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableVLANRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VLAN' description: '' delete: operationId: ipam_vlans_destroy description: Delete a VLAN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VLAN. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vrfs/: get: operationId: ipam_vrfs_list description: Get a list of VRF objects. parameters: - in: query name: created schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created__n schema: type: array items: type: string format: date-time explode: true style: form - in: query name: created_by_request schema: type: string format: uuid - in: query name: description schema: type: array items: type: string explode: true style: form - in: query name: description__empty schema: type: boolean - in: query name: description__ic schema: type: array items: type: string explode: true style: form - in: query name: description__ie schema: type: array items: type: string explode: true style: form - in: query name: description__iew schema: type: array items: type: string explode: true style: form - in: query name: description__iregex schema: type: array items: type: string explode: true style: form - in: query name: description__isw schema: type: array items: type: string explode: true style: form - in: query name: description__n schema: type: array items: type: string explode: true style: form - in: query name: description__nic schema: type: array items: type: string explode: true style: form - in: query name: description__nie schema: type: array items: type: string explode: true style: form - in: query name: description__niew schema: type: array items: type: string explode: true style: form - in: query name: description__nisw schema: type: array items: type: string explode: true style: form - in: query name: description__regex schema: type: array items: type: string explode: true style: form - in: query name: enforce_unique schema: type: boolean - in: query name: export_target schema: type: array items: type: string description: Export target (name) explode: true style: form - in: query name: export_target__n schema: type: array items: type: string description: Export target (name) explode: true style: form - in: query name: export_target_id schema: type: array items: type: integer description: Export target explode: true style: form - in: query name: export_target_id__n schema: type: array items: type: integer description: Export target explode: true style: form - in: query name: id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__empty schema: type: boolean - in: query name: id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: import_target schema: type: array items: type: string description: Import target (name) explode: true style: form - in: query name: import_target__n schema: type: array items: type: string description: Import target (name) explode: true style: form - in: query name: import_target_id schema: type: array items: type: integer description: Import target explode: true style: form - in: query name: import_target_id__n schema: type: array items: type: integer description: Import target explode: true style: form - in: query name: last_updated schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__empty schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__gte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lt schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__lte schema: type: array items: type: string format: date-time explode: true style: form - in: query name: last_updated__n schema: type: array items: type: string format: date-time explode: true style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: modified_by_request schema: type: string format: uuid - in: query name: name schema: type: array items: type: string explode: true style: form - in: query name: name__empty schema: type: boolean - in: query name: name__ic schema: type: array items: type: string explode: true style: form - in: query name: name__ie schema: type: array items: type: string explode: true style: form - in: query name: name__iew schema: type: array items: type: string explode: true style: form - in: query name: name__iregex schema: type: array items: type: string explode: true style: form - in: query name: name__isw schema: type: array items: type: string explode: true style: form - in: query name: name__n schema: type: array items: type: string explode: true style: form - in: query name: name__nic schema: type: array items: type: string explode: true style: form - in: query name: name__nie schema: type: array items: type: string explode: true style: form - in: query name: name__niew schema: type: array items: type: string explode: true style: form - in: query name: name__nisw schema: type: array items: type: string explode: true style: form - in: query name: name__regex schema: type: array items: type: string explode: true style: form - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: owner schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner__n schema: type: array items: type: string description: Owner (name) explode: true style: form - in: query name: owner_group schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group__n schema: type: array items: type: string description: Owner Group (name) explode: true style: form - in: query name: owner_group_id schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_group_id__n schema: type: array items: type: integer description: Owner Group (ID) explode: true style: form - in: query name: owner_id schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: owner_id__n schema: type: array items: type: integer nullable: true description: Owner (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: rd schema: type: array items: type: string explode: true style: form - in: query name: rd__empty schema: type: boolean - in: query name: rd__ic schema: type: array items: type: string explode: true style: form - in: query name: rd__ie schema: type: array items: type: string explode: true style: form - in: query name: rd__iew schema: type: array items: type: string explode: true style: form - in: query name: rd__iregex schema: type: array items: type: string explode: true style: form - in: query name: rd__isw schema: type: array items: type: string explode: true style: form - in: query name: rd__n schema: type: array items: type: string explode: true style: form - in: query name: rd__nic schema: type: array items: type: string explode: true style: form - in: query name: rd__nie schema: type: array items: type: string explode: true style: form - in: query name: rd__niew schema: type: array items: type: string explode: true style: form - in: query name: rd__nisw schema: type: array items: type: string explode: true style: form - in: query name: rd__regex schema: type: array items: type: string explode: true style: form - in: query name: tag schema: type: array items: type: string explode: true style: form - in: query name: tag__n schema: type: array items: type: string explode: true style: form - in: query name: tag_id schema: type: array items: type: integer explode: true style: form - in: query name: tag_id__n schema: type: array items: type: integer explode: true style: form - in: query name: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedVRFList' description: '' post: operationId: ipam_vrfs_create description: Post a list of VRF objects. tags: - ipam requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/VRFRequest' - type: array items: $ref: '#/components/schemas/VRFRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/VRFRequest' - type: array items: $ref: '#/components/schemas/VRFRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/VRF' description: '' put: operationId: ipam_vrfs_bulk_update description: Put a list of VRF objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VRFRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VRFRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VRF' description: '' patch: operationId: ipam_vrfs_bulk_partial_update description: Patch a list of VRF objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VRFRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VRFRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/VRF' description: '' delete: operationId: ipam_vrfs_bulk_destroy description: Delete a list of VRF objects. tags: - ipam requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/VRFRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/VRFRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/ipam/vrfs/{id}/: get: operationId: ipam_vrfs_retrieve description: Get a VRF object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VRF. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VRF' description: '' put: operationId: ipam_vrfs_update description: Put a VRF object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VRF. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/VRFRequest' multipart/form-data: schema: $ref: '#/components/schemas/VRFRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VRF' description: '' patch: operationId: ipam_vrfs_partial_update description: Patch a VRF object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VRF. required: true tags: - ipam requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedVRFRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedVRFRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/VRF' description: '' delete: operationId: ipam_vrfs_destroy description: Delete a VRF object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this VRF. required: true tags: - ipam security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body components: schemas: IntegerRange: type: array items: type: integer minItems: 2 maxItems: 2 example: - 10 - 20 PatchedASNRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: asn: type: integer maximum: 4294967295 minimum: 1 format: int64 description: 16- or 32-bit autonomous system number rir: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRIRRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} sites: type: array items: type: integer PaginatedVRFList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VRF' FHRPGroup: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true name: type: string maxLength: 100 url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true protocol: enum: - vrrp2 - vrrp3 - carp - clusterxl - hsrp - glbp - other type: string description: '* `vrrp2` - VRRPv2 * `vrrp3` - VRRPv3 * `carp` - CARP * `clusterxl` - ClusterXL * `hsrp` - HSRP * `glbp` - GLBP * `other` - Other' x-spec-enum-id: 98de93c9f65d1c65 group_id: type: integer maximum: 32767 minimum: 0 auth_type: enum: - plaintext - md5 - '' - null type: string description: '* `plaintext` - Plaintext * `md5` - MD5' x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type auth_key: type: string title: Authentication key maxLength: 255 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true ip_addresses: type: array items: $ref: '#/components/schemas/BriefIPAddress' readOnly: true required: - created - display - display_url - group_id - id - ip_addresses - last_updated - protocol - url WritableAggregateRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: prefix: type: string minLength: 1 rir: oneOf: - type: integer - $ref: '#/components/schemas/BriefRIRRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true date_added: type: string format: date nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - prefix - rir ASNRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: asn: type: integer maximum: 4294967295 minimum: 1 format: int64 description: 16- or 32-bit autonomous system number rir: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRIRRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} sites: type: array items: type: integer required: - asn FHRPGroupRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string maxLength: 100 protocol: enum: - vrrp2 - vrrp3 - carp - clusterxl - hsrp - glbp - other type: string description: '* `vrrp2` - VRRPv2 * `vrrp3` - VRRPv3 * `carp` - CARP * `clusterxl` - ClusterXL * `hsrp` - HSRP * `glbp` - GLBP * `other` - Other' x-spec-enum-id: 98de93c9f65d1c65 group_id: type: integer maximum: 32767 minimum: 0 auth_type: enum: - plaintext - md5 - '' - null type: string description: '* `plaintext` - Plaintext * `md5` - MD5' x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type auth_key: type: string title: Authentication key maxLength: 255 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - group_id - protocol PatchedRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ weight: type: integer maximum: 32767 minimum: 0 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} Prefix: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true prefix: type: string vrf: allOf: - $ref: '#/components/schemas/BriefVRF' nullable: true scope_type: type: string nullable: true scope_id: type: integer nullable: true scope: readOnly: true nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true vlan: allOf: - $ref: '#/components/schemas/BriefVLAN' nullable: true status: type: object properties: value: enum: - container - active - reserved - deprecated type: string description: '* `container` - Container * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: 026173ce39f2ee63 label: type: string enum: - Container - Active - Reserved - Deprecated role: allOf: - $ref: '#/components/schemas/BriefRole' nullable: true is_pool: type: boolean title: Is a pool description: All IP addresses within this prefix are considered usable mark_utilized: type: boolean description: Treat as fully utilized description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true children: type: integer readOnly: true _depth: type: integer readOnly: true title: ' depth' required: - _depth - children - created - display - display_url - family - id - last_updated - prefix - scope - url IPRangeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: start_address: type: string minLength: 1 end_address: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: ca933c38b935e547 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} mark_populated: type: boolean description: Prevent the creation of IP addresses within this range mark_utilized: type: boolean description: Report space as fully utilized required: - end_address - start_address FHRPGroupAssignmentRequest: type: object description: Adds support for custom fields and tags. properties: group: oneOf: - type: integer - $ref: '#/components/schemas/BriefFHRPGroupRequest' interface_type: type: string interface_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 priority: type: integer maximum: 255 minimum: 0 required: - group - interface_id - interface_type - priority RIR: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ is_private: type: boolean title: Private description: IP space managed by this RIR is considered private description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true aggregate_count: type: integer format: int64 readOnly: true required: - aggregate_count - created - display - display_url - id - last_updated - name - slug - url PaginatedIPAddressList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IPAddress' ServiceRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: parent_object_type: type: string parent_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 name: type: string minLength: 1 maxLength: 100 protocol: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers ipaddresses: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - parent_object_id - parent_object_type - ports PatchedWritablePrefixRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: prefix: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true scope_type: type: string nullable: true scope_id: type: integer nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true vlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true status: enum: - container - active - reserved - deprecated type: string x-spec-enum-id: 026173ce39f2ee63 description: 'Operational status of this prefix * `container` - Container * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true is_pool: type: boolean title: Is a pool description: All IP addresses within this prefix are considered usable mark_utilized: type: boolean description: Treat as fully utilized description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefOwner: type: object 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 readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url PaginatedFHRPGroupAssignmentList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/FHRPGroupAssignment' WritableIPRangeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: start_address: type: string minLength: 1 end_address: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string x-spec-enum-id: ca933c38b935e547 description: 'Operational status of this range * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} mark_populated: type: boolean description: Prevent the creation of IP addresses within this range mark_utilized: type: boolean description: Report space as fully utilized required: - end_address - start_address AvailablePrefix: type: object description: Representation of a prefix which does not exist in the database. properties: family: type: integer readOnly: true prefix: type: string readOnly: true vrf: allOf: - $ref: '#/components/schemas/BriefVRF' readOnly: true nullable: true required: - family - prefix - vrf PaginatedASNList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ASN' WritableServiceTemplateRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 protocol: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - ports - protocol PatchedVRFRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true enforce_unique: type: boolean title: Enforce unique space description: Prevent duplicate prefixes/IP addresses within this VRF description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string import_targets: type: array items: type: integer export_targets: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefL2VPNTermination: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true l2vpn: $ref: '#/components/schemas/BriefL2VPN' required: - display - id - l2vpn - url PatchedWritableServiceTemplateRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 protocol: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedVLANGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VLANGroup' AvailableVLAN: type: object description: Representation of a VLAN which does not exist in the database. properties: vid: type: integer readOnly: true group: allOf: - $ref: '#/components/schemas/BriefVLANGroup' readOnly: true nullable: true required: - group - vid WritableServiceRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: parent_object_type: type: string parent_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 name: type: string minLength: 1 maxLength: 100 protocol: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers ipaddresses: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - parent_object_id - parent_object_type - ports - protocol PaginatedIPRangeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IPRange' ASNRange: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ rir: $ref: '#/components/schemas/BriefRIR' start: type: integer maximum: 4294967295 minimum: 1 format: int64 end: type: integer maximum: 4294967295 minimum: 1 format: int64 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true asn_count: type: integer readOnly: true required: - asn_count - created - display - display_url - end - id - last_updated - name - rir - slug - start - url BriefVRFRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 description: type: string maxLength: 200 required: - name BriefVLANGroup: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 vlan_count: type: integer format: int64 readOnly: true required: - display - id - name - slug - url - vlan_count PatchedWritableServiceRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: parent_object_type: type: string parent_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 name: type: string minLength: 1 maxLength: 100 protocol: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers ipaddresses: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedServiceTemplateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ServiceTemplate' PatchedFHRPGroupAssignmentRequest: type: object description: Adds support for custom fields and tags. properties: group: oneOf: - type: integer - $ref: '#/components/schemas/BriefFHRPGroupRequest' interface_type: type: string interface_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 priority: type: integer maximum: 255 minimum: 0 AvailableIP: type: object description: Representation of an IP address which does not exist in the database. properties: family: type: integer readOnly: true address: type: string readOnly: true vrf: allOf: - $ref: '#/components/schemas/BriefVRF' readOnly: true nullable: true description: type: string required: - address - family - vrf RouteTarget: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - url PatchedVLANGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ scope_type: type: string nullable: true scope_id: type: integer nullable: true vid_ranges: type: array items: $ref: '#/components/schemas/IntegerRangeRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefIPAddress: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true address: type: string description: type: string maxLength: 200 required: - address - display - family - id - url PaginatedAggregateList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Aggregate' BriefOwnerRequest: type: object 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: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name PatchedRouteTargetRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedRouteTargetList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RouteTarget' PrefixRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: prefix: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true scope_type: type: string nullable: true scope_id: type: integer nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true vlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true status: enum: - container - active - reserved - deprecated type: string description: '* `container` - Container * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: 026173ce39f2ee63 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true is_pool: type: boolean title: Is a pool description: All IP addresses within this prefix are considered usable mark_utilized: type: boolean description: Treat as fully utilized description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - prefix AvailableASN: type: object description: Representation of an ASN which does not exist in the database. properties: asn: type: integer readOnly: true description: type: string required: - asn BriefSite: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the site maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - display - id - name - slug - url VRFRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true enforce_unique: type: boolean title: Enforce unique space description: Prevent duplicate prefixes/IP addresses within this VRF description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string import_targets: type: array items: type: integer export_targets: type: array items: type: integer tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name Service: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true parent_object_type: type: string parent_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 parent: readOnly: true nullable: true name: type: string maxLength: 100 protocol: type: object properties: value: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 label: type: string enum: - TCP - UDP - SCTP ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers ipaddresses: type: array items: $ref: '#/components/schemas/IPAddress' description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - parent - parent_object_id - parent_object_type - ports - url RouteTargetRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name PatchedASNRangeRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ rir: oneOf: - type: integer - $ref: '#/components/schemas/BriefRIRRequest' start: type: integer maximum: 4294967295 minimum: 1 format: int64 end: type: integer maximum: 4294967295 minimum: 1 format: int64 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} NestedIPAddress: type: object description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: integer readOnly: true address: type: string required: - address - display - display_url - family - id - url PatchedVLANTranslationPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string VLAN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true site: allOf: - $ref: '#/components/schemas/BriefSite' nullable: true group: allOf: - $ref: '#/components/schemas/BriefVLANGroup' nullable: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string maxLength: 64 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true status: type: object properties: value: enum: - active - reserved - deprecated type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: ca933c38b935e547 label: type: string enum: - Active - Reserved - Deprecated role: allOf: - $ref: '#/components/schemas/BriefRole' nullable: true description: type: string maxLength: 200 qinq_role: type: object properties: value: enum: - svlan - cvlan - null type: string description: '* `svlan` - Service * `cvlan` - Customer' x-spec-enum-id: fa0abd59fb1a7312 label: type: string enum: - Service - Customer nullable: true qinq_svlan: allOf: - $ref: '#/components/schemas/NestedVLAN' nullable: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string l2vpn_termination: allOf: - $ref: '#/components/schemas/BriefL2VPNTermination' readOnly: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true prefix_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - l2vpn_termination - last_updated - name - prefix_count - url - vid VLANRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANGroupRequest' nullable: true nullable: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string minLength: 1 maxLength: 64 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: ca933c38b935e547 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 qinq_role: enum: - svlan - cvlan - null type: string description: '* `svlan` - Service * `cvlan` - Customer' x-spec-enum-id: fa0abd59fb1a7312 nullable: true qinq_svlan: allOf: - $ref: '#/components/schemas/NestedVLANRequest' nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - vid PaginatedASNRangeList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ASNRange' BriefRIRRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug PatchedWritableAggregateRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: prefix: type: string minLength: 1 rir: oneOf: - type: integer - $ref: '#/components/schemas/BriefRIRRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true date_added: type: string format: date nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefVLAN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string maxLength: 64 description: type: string maxLength: 200 required: - display - id - name - url - vid PatchedWritableIPAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: address: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated - dhcp - slaac type: string x-spec-enum-id: c421c4c4a0fa7a2a description: 'The operational status of this IP * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated * `dhcp` - DHCP * `slaac` - SLAAC' role: enum: - loopback - secondary - anycast - vip - vrrp - hsrp - glbp - carp - '' - null type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: 'The functional role of this IP * `loopback` - Loopback * `secondary` - Secondary * `anycast` - Anycast * `vip` - VIP * `vrrp` - VRRP * `hsrp` - HSRP * `glbp` - GLBP * `carp` - CARP' assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true nat_inside: type: integer nullable: true title: NAT (inside) description: The IP for which this address is the "outside" IP dns_name: type: string description: Hostname or FQDN (not case-sensitive) pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ maxLength: 255 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedRoleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Role' RIRRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ is_private: type: boolean title: Private description: IP space managed by this RIR is considered private description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug AvailableIPRequestRequest: type: object description: Request payload for creating IP addresses from the available-ips endpoint. properties: prefix_length: type: integer IntegerRangeRequest: type: array items: type: integer minItems: 2 maxItems: 2 example: - 10 - 20 NestedVLANRequest: type: object description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 required: - name - vid PaginatedVLANTranslationPolicyList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VLANTranslationPolicy' IPAddress: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true address: type: string vrf: allOf: - $ref: '#/components/schemas/BriefVRF' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true status: type: object properties: value: enum: - active - reserved - deprecated - dhcp - slaac type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated * `dhcp` - DHCP * `slaac` - SLAAC' x-spec-enum-id: c421c4c4a0fa7a2a label: type: string enum: - Active - Reserved - Deprecated - DHCP - SLAAC role: type: object properties: value: enum: - loopback - secondary - anycast - vip - vrrp - hsrp - glbp - carp - '' type: string description: '* `loopback` - Loopback * `secondary` - Secondary * `anycast` - Anycast * `vip` - VIP * `vrrp` - VRRP * `hsrp` - HSRP * `glbp` - GLBP * `carp` - CARP' x-spec-enum-id: 53dca4cddd7b344a label: type: string enum: - Loopback - Secondary - Anycast - VIP - VRRP - HSRP - GLBP - CARP assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true assigned_object: readOnly: true nullable: true nat_inside: allOf: - $ref: '#/components/schemas/NestedIPAddress' nullable: true nat_outside: type: array items: $ref: '#/components/schemas/NestedIPAddress' readOnly: true dns_name: type: string description: Hostname or FQDN (not case-sensitive) pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ maxLength: 255 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - address - assigned_object - created - display - display_url - family - id - last_updated - nat_outside - url Aggregate: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true prefix: type: string rir: $ref: '#/components/schemas/BriefRIR' tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true date_added: type: string format: date nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - family - id - last_updated - prefix - rir - url BriefRole: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 prefix_count: type: integer format: int64 readOnly: true vlan_count: type: integer format: int64 readOnly: true required: - display - id - name - prefix_count - slug - url - vlan_count PaginatedServiceList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Service' ServiceTemplate: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 protocol: type: object properties: value: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 label: type: string enum: - TCP - UDP - SCTP ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - ports - url PaginatedPrefixList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Prefix' BriefFHRPGroupRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: protocol: enum: - vrrp2 - vrrp3 - carp - clusterxl - hsrp - glbp - other type: string description: '* `vrrp2` - VRRPv2 * `vrrp3` - VRRPv3 * `carp` - CARP * `clusterxl` - ClusterXL * `hsrp` - HSRP * `glbp` - GLBP * `other` - Other' x-spec-enum-id: 98de93c9f65d1c65 group_id: type: integer maximum: 32767 minimum: 0 description: type: string maxLength: 200 required: - group_id - protocol PatchedVLANTranslationRuleRequest: type: object description: Adds support for custom fields and tags. properties: policy: type: integer local_vid: type: integer maximum: 4094 minimum: 1 title: Local VLAN ID description: Numeric VLAN ID (1-4094) remote_vid: type: integer maximum: 4094 minimum: 1 title: Remote VLAN ID description: Numeric VLAN ID (1-4094) description: type: string maxLength: 200 VLANTranslationPolicy: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 rules: type: array items: $ref: '#/components/schemas/VLANTranslationRule' readOnly: true owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string required: - display - id - name - rules - url VLANGroup: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ scope_type: type: string nullable: true scope_id: type: integer nullable: true scope: readOnly: true nullable: true vid_ranges: type: array items: $ref: '#/components/schemas/IntegerRange' tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true vlan_count: type: integer format: int64 readOnly: true utilization: type: string readOnly: true required: - created - display - display_url - id - last_updated - name - scope - slug - url - utilization - vlan_count BriefL2VPN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: type: object properties: value: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc label: type: string enum: - VPWS - VPLS - VXLAN - VXLAN-EVPN - MPLS EVPN - PBB EVPN - EVPN VPWS - EPL - EVPL - Ethernet Private LAN - Ethernet Virtual Private LAN - Ethernet Private Tree - Ethernet Virtual Private Tree - SPB description: type: string maxLength: 200 required: - display - id - name - slug - url BriefSiteRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 description: Full name of the site maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug PaginatedFHRPGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/FHRPGroup' RoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ weight: type: integer maximum: 32767 minimum: 0 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug FHRPGroupAssignment: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true group: $ref: '#/components/schemas/BriefFHRPGroup' interface_type: type: string interface_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 interface: readOnly: true nullable: true priority: type: integer maximum: 255 minimum: 0 created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - group - id - interface - interface_id - interface_type - last_updated - priority - url ServiceTemplateRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 protocol: enum: - tcp - udp - sctp type: string description: '* `tcp` - TCP * `udp` - UDP * `sctp` - SCTP' x-spec-enum-id: e4b15bec749a2a32 ports: type: array items: type: integer maximum: 65535 minimum: 1 title: Port numbers description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - ports WritableIPAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: address: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated - dhcp - slaac type: string x-spec-enum-id: c421c4c4a0fa7a2a description: 'The operational status of this IP * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated * `dhcp` - DHCP * `slaac` - SLAAC' role: enum: - loopback - secondary - anycast - vip - vrrp - hsrp - glbp - carp - '' - null type: string x-spec-enum-id: 53dca4cddd7b344a nullable: true description: 'The functional role of this IP * `loopback` - Loopback * `secondary` - Secondary * `anycast` - Anycast * `vip` - VIP * `vrrp` - VRRP * `hsrp` - HSRP * `glbp` - GLBP * `carp` - CARP' assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true nat_inside: type: integer nullable: true title: NAT (inside) description: The IP for which this address is the "outside" IP dns_name: type: string description: Hostname or FQDN (not case-sensitive) pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ maxLength: 255 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - address NestedVLAN: type: object description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string maxLength: 64 description: type: string maxLength: 200 required: - display - id - name - url - vid PaginatedVLANTranslationRuleList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VLANTranslationRule' BriefFHRPGroup: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true protocol: enum: - vrrp2 - vrrp3 - carp - clusterxl - hsrp - glbp - other type: string description: '* `vrrp2` - VRRPv2 * `vrrp3` - VRRPv3 * `carp` - CARP * `clusterxl` - ClusterXL * `hsrp` - HSRP * `glbp` - GLBP * `other` - Other' x-spec-enum-id: 98de93c9f65d1c65 group_id: type: integer maximum: 32767 minimum: 0 description: type: string maxLength: 200 required: - display - group_id - id - protocol - url BriefRIR: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 aggregate_count: type: integer format: int64 readOnly: true required: - aggregate_count - display - id - name - slug - url PaginatedVLANList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/VLAN' AggregateRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: prefix: type: string minLength: 1 rir: oneOf: - type: integer - $ref: '#/components/schemas/BriefRIRRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true date_added: type: string format: date nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - prefix - rir VRF: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true enforce_unique: type: boolean title: Enforce unique space description: Prevent duplicate prefixes/IP addresses within this VRF description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string import_targets: type: array items: $ref: '#/components/schemas/RouteTarget' export_targets: type: array items: $ref: '#/components/schemas/RouteTarget' tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true ipaddress_count: type: integer format: int64 readOnly: true prefix_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - ipaddress_count - last_updated - name - prefix_count - url IPRange: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true start_address: type: string end_address: type: string size: type: integer readOnly: true vrf: allOf: - $ref: '#/components/schemas/BriefVRF' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true status: type: object properties: value: enum: - active - reserved - deprecated type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: ca933c38b935e547 label: type: string enum: - Active - Reserved - Deprecated role: allOf: - $ref: '#/components/schemas/BriefRole' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true mark_populated: type: boolean description: Prevent the creation of IP addresses within this range mark_utilized: type: boolean description: Report space as fully utilized required: - created - display - display_url - end_address - family - id - last_updated - size - start_address - url Role: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ weight: type: integer maximum: 32767 minimum: 0 description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true prefix_count: type: integer format: int64 readOnly: true vlan_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - last_updated - name - prefix_count - slug - url - vlan_count PaginatedRIRList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/RIR' PrefixLengthRequest: type: object properties: prefix_length: type: integer required: - prefix_length VLANGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ scope_type: type: string nullable: true scope_id: type: integer nullable: true vid_ranges: type: array items: $ref: '#/components/schemas/IntegerRangeRequest' tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug WritablePrefixRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: prefix: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true scope_type: type: string nullable: true scope_id: type: integer nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true vlan: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANRequest' nullable: true nullable: true status: enum: - container - active - reserved - deprecated type: string x-spec-enum-id: 026173ce39f2ee63 description: 'Operational status of this prefix * `container` - Container * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true is_pool: type: boolean title: Is a pool description: All IP addresses within this prefix are considered usable mark_utilized: type: boolean description: Treat as fully utilized description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - prefix ASNRangeRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ rir: oneOf: - type: integer - $ref: '#/components/schemas/BriefRIRRequest' start: type: integer maximum: 4294967295 minimum: 1 format: int64 end: type: integer maximum: 4294967295 minimum: 1 format: int64 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - end - name - rir - slug - start CreateAvailableVLANRequest: type: object description: Adds support for custom fields and tags. properties: name: type: string minLength: 1 maxLength: 64 site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' x-spec-enum-id: ca933c38b935e547 role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name PatchedRIRRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ is_private: type: boolean title: Private description: IP space managed by this RIR is considered private description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefRoleRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug BriefTenantRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug VLANTranslationPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string required: - name WritableVLANRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANGroupRequest' nullable: true nullable: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string minLength: 1 maxLength: 64 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string x-spec-enum-id: ca933c38b935e547 description: 'Operational status of this VLAN * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 qinq_role: enum: - svlan - cvlan - '' - null type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: 'Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) * `svlan` - Service * `cvlan` - Customer' qinq_svlan: type: integer nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - vid ASNSite: type: object description: 'This serializer is meant for inclusion in ASNSerializer and is only used to avoid a circular import of SiteSerializer.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Full name of the site maxLength: 100 description: type: string maxLength: 200 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ required: - display - id - name - slug - url PatchedWritableVLANRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: site: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefSiteRequest' nullable: true nullable: true group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVLANGroupRequest' nullable: true nullable: true vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string minLength: 1 maxLength: 64 tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string x-spec-enum-id: ca933c38b935e547 description: 'Operational status of this VLAN * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 qinq_role: enum: - svlan - cvlan - '' - null type: string x-spec-enum-id: fa0abd59fb1a7312 nullable: true title: Q-in-Q role description: 'Customer/service VLAN designation (for Q-in-Q/IEEE 802.1ad) * `svlan` - Service * `cvlan` - Customer' qinq_svlan: type: integer nullable: true owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} NestedIPAddressRequest: type: object description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: address: type: string minLength: 1 required: - address NestedTag: type: object description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string pattern: ^[-\w]+$ maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 required: - display - display_url - id - name - slug - url BriefTenant: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - display - id - name - slug - url PatchedWritableIPRangeRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: start_address: type: string minLength: 1 end_address: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated type: string x-spec-enum-id: ca933c38b935e547 description: 'Operational status of this range * `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated' role: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefRoleRequest' nullable: true nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} mark_populated: type: boolean description: Prevent the creation of IP addresses within this range mark_utilized: type: boolean description: Report space as fully utilized VLANTranslationRuleRequest: type: object description: Adds support for custom fields and tags. properties: policy: type: integer local_vid: type: integer maximum: 4094 minimum: 1 title: Local VLAN ID description: Numeric VLAN ID (1-4094) remote_vid: type: integer maximum: 4094 minimum: 1 title: Remote VLAN ID description: Numeric VLAN ID (1-4094) description: type: string maxLength: 200 required: - local_vid - policy - remote_vid IPAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: address: type: string minLength: 1 vrf: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefVRFRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true status: enum: - active - reserved - deprecated - dhcp - slaac type: string description: '* `active` - Active * `reserved` - Reserved * `deprecated` - Deprecated * `dhcp` - DHCP * `slaac` - SLAAC' x-spec-enum-id: c421c4c4a0fa7a2a role: enum: - loopback - secondary - anycast - vip - vrrp - hsrp - glbp - carp - '' type: string description: '* `loopback` - Loopback * `secondary` - Secondary * `anycast` - Anycast * `vip` - VIP * `vrrp` - VRRP * `hsrp` - HSRP * `glbp` - GLBP * `carp` - CARP' x-spec-enum-id: 53dca4cddd7b344a assigned_object_type: type: string nullable: true assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true nat_inside: allOf: - $ref: '#/components/schemas/NestedIPAddressRequest' nullable: true dns_name: type: string description: Hostname or FQDN (not case-sensitive) pattern: ^([0-9A-Za-z_-]+|\*)(\.[0-9A-Za-z_-]+)*\.?$ maxLength: 255 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - address PatchedFHRPGroupRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string maxLength: 100 protocol: enum: - vrrp2 - vrrp3 - carp - clusterxl - hsrp - glbp - other type: string description: '* `vrrp2` - VRRPv2 * `vrrp3` - VRRPv3 * `carp` - CARP * `clusterxl` - ClusterXL * `hsrp` - HSRP * `glbp` - GLBP * `other` - Other' x-spec-enum-id: 98de93c9f65d1c65 group_id: type: integer maximum: 32767 minimum: 0 auth_type: enum: - plaintext - md5 - '' - null type: string description: '* `plaintext` - Plaintext * `md5` - MD5' x-spec-enum-id: 565396e386e1542a nullable: true title: Authentication type auth_key: type: string title: Authentication key maxLength: 255 description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefVRF: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 rd: type: string nullable: true title: Route distinguisher description: Unique route distinguisher (as defined in RFC 4364) maxLength: 21 description: type: string maxLength: 200 prefix_count: type: integer format: int64 readOnly: true required: - display - id - name - prefix_count - url BriefVLANGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug ASN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true asn: type: integer maximum: 4294967295 minimum: 1 format: int64 description: 16- or 32-bit autonomous system number rir: allOf: - $ref: '#/components/schemas/BriefRIR' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true site_count: type: integer format: int64 readOnly: true provider_count: type: integer format: int64 readOnly: true sites: type: array items: $ref: '#/components/schemas/ASNSite' required: - asn - created - display - display_url - id - last_updated - provider_count - site_count - url VLANTranslationRule: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true policy: type: integer local_vid: type: integer maximum: 4094 minimum: 1 title: Local VLAN ID description: Numeric VLAN ID (1-4094) remote_vid: type: integer maximum: 4094 minimum: 1 title: Remote VLAN ID description: Numeric VLAN ID (1-4094) description: type: string maxLength: 200 required: - display - id - local_vid - policy - remote_vid - url BriefVLANRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: vid: type: integer maximum: 4094 minimum: 1 title: VLAN ID description: Numeric VLAN ID (1-4094) name: type: string minLength: 1 maxLength: 64 description: type: string maxLength: 200 required: - name - vid NestedTagRequest: type: object description: 'Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 pattern: ^[-\w]+$ maxLength: 100 color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 required: - name - slug securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid tokenAuth: type: apiKey in: header name: Authorization description: '`Token ` (v1) or `Bearer .` (v2)'