IP address management and DNS/DHCP (DDI). Auto-generated from the platform OpenAPI schema so it matches the running API.
REST API for this feature — 91 operations across 43 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).
Base URL
https://<your-versus-host>/api· AuthAuthorization: Bearer <JWT>(fromPOST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.
GET /api/ipam/addresses/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
network | query | no | integer | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
status | query | no | string | * free - Free |
Responses: 200 → PaginatedIPAddressList
POST /api/ipam/addresses/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): IPAddressRequest
Responses: 201 → IPAddress
GET /api/ipam/addresses/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this ip address. |
Responses: 200 → IPAddress
PUT /api/ipam/addresses/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this ip address. |
Request body (application/json): IPAddressRequest
Responses: 200 → IPAddress
PATCH /api/ipam/addresses/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this ip address. |
Request body (application/json): PatchedIPAddressRequest
Responses: 200 → IPAddress
DELETE /api/ipam/addresses/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this ip address. |
Responses: 204
GET /api/ipam/containers/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
network_view | query | no | integer | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedNetworkContainerList
POST /api/ipam/containers/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): NetworkContainerRequest
Responses: 201 → NetworkContainer
GET /api/ipam/containers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network container. |
Responses: 200 → NetworkContainer
PUT /api/ipam/containers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network container. |
Request body (application/json): NetworkContainerRequest
Responses: 200 → NetworkContainer
PATCH /api/ipam/containers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network container. |
Request body (application/json): PatchedNetworkContainerRequest
Responses: 200 → NetworkContainer
DELETE /api/ipam/containers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network container. |
Responses: 204
GET /api/ipam/dhcp-leases/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
binding_state | query | no | string | |
network | query | no | integer | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedDHCPLeaseList
POST /api/ipam/dhcp-leases/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DHCPLeaseRequest
Responses: 201 → DHCPLease
GET /api/ipam/dhcp-leases/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp lease. |
Responses: 200 → DHCPLease
PUT /api/ipam/dhcp-leases/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp lease. |
Request body (application/json): DHCPLeaseRequest
Responses: 200 → DHCPLease
PATCH /api/ipam/dhcp-leases/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp lease. |
Request body (application/json): PatchedDHCPLeaseRequest
Responses: 200 → DHCPLease
DELETE /api/ipam/dhcp-leases/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp lease. |
Responses: 204
GET /api/ipam/dhcp-ranges/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
is_active | query | no | boolean | |
network | query | no | integer | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
Responses: 200 → PaginatedDHCPRangeList
POST /api/ipam/dhcp-ranges/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DHCPRangeRequest
Responses: 201 → DHCPRange
GET /api/ipam/dhcp-ranges/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp range. |
Responses: 200 → DHCPRange
PUT /api/ipam/dhcp-ranges/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp range. |
Request body (application/json): DHCPRangeRequest
Responses: 200 → DHCPRange
PATCH /api/ipam/dhcp-ranges/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp range. |
Request body (application/json): PatchedDHCPRangeRequest
Responses: 200 → DHCPRange
DELETE /api/ipam/dhcp-ranges/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dhcp range. |
Responses: 204
GET /api/ipam/dns/records/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
auto_created | query | no | boolean | |
disabled | query | no | boolean | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
record_type | query | no | string | * A - A |
search | query | no | string | A search term. |
zone | query | no | integer |
Responses: 200 → PaginatedDNSRecordList
POST /api/ipam/dns/records/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DNSRecordRequest
Responses: 201 → DNSRecord
GET /api/ipam/dns/records/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns record. |
Responses: 200 → DNSRecord
PUT /api/ipam/dns/records/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns record. |
Request body (application/json): DNSRecordRequest
Responses: 200 → DNSRecord
PATCH /api/ipam/dns/records/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns record. |
Request body (application/json): PatchedDNSRecordRequest
Responses: 200 → DNSRecord
DELETE /api/ipam/dns/records/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns record. |
Responses: 204
GET /api/ipam/dns/servers/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedDNSServerList
POST /api/ipam/dns/servers/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DNSServerRequest
Responses: 201 → DNSServer
GET /api/ipam/dns/servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns server. |
Responses: 200 → DNSServer
PUT /api/ipam/dns/servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns server. |
Request body (application/json): DNSServerRequest
Responses: 200 → DNSServer
PATCH /api/ipam/dns/servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns server. |
Request body (application/json): PatchedDNSServerRequest
Responses: 200 → DNSServer
DELETE /api/ipam/dns/servers/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns server. |
Responses: 204
POST /api/ipam/dns/servers/{id}/test_notify/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns server. |
Request body (application/json): DNSServerRequest
Responses: 200 → DNSServer
GET /api/ipam/dns/views/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedDNSViewList
POST /api/ipam/dns/views/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DNSViewRequest
Responses: 201 → DNSView
GET /api/ipam/dns/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns view. |
Responses: 200 → DNSView
PUT /api/ipam/dns/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns view. |
Request body (application/json): DNSViewRequest
Responses: 200 → DNSView
PATCH /api/ipam/dns/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns view. |
Request body (application/json): PatchedDNSViewRequest
Responses: 200 → DNSView
DELETE /api/ipam/dns/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns view. |
Responses: 204
GET /api/ipam/dns/zones/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
is_locked | query | no | boolean | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
view | query | no | integer | |
zone_type | query | no | string | * forward - Forward |
Responses: 200 → PaginatedDNSZoneList
POST /api/ipam/dns/zones/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DNSZoneRequest
Responses: 201 → DNSZone
GET /api/ipam/dns/zones/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Responses: 200 → DNSZone
PUT /api/ipam/dns/zones/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Request body (application/json): DNSZoneRequest
Responses: 200 → DNSZone
PATCH /api/ipam/dns/zones/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Request body (application/json): PatchedDNSZoneRequest
Responses: 200 → DNSZone
DELETE /api/ipam/dns/zones/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Responses: 204
POST /api/ipam/dns/zones/{id}/bump_serial/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Request body (application/json): DNSZoneRequest
Responses: 200 → DNSZone
POST /api/ipam/dns/zones/{id}/notify/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Request body (application/json): DNSZoneRequest
Responses: 200 → DNSZone
GET /api/ipam/dns/zones/{id}/zonefile/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dns zone. |
Responses: 200 → DNSZone
GET /api/ipam/dnssec/keys/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
key_type | query | no | string | * ZSK - Zone Signing Key |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
state | query | no | string | * generated - Generated |
zone | query | no | integer |
Responses: 200 → PaginatedDNSSECKeyList
POST /api/ipam/dnssec/keys/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DNSSECKeyRequest
Responses: 201 → DNSSECKey
GET /api/ipam/dnssec/keys/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Responses: 200 → DNSSECKey
PUT /api/ipam/dnssec/keys/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Request body (application/json): DNSSECKeyRequest
Responses: 200 → DNSSECKey
PATCH /api/ipam/dnssec/keys/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Request body (application/json): PatchedDNSSECKeyRequest
Responses: 200 → DNSSECKey
DELETE /api/ipam/dnssec/keys/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Responses: 204
POST /api/ipam/dnssec/keys/{id}/activate/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Request body (application/json): DNSSECKeyRequest
Responses: 200 → DNSSECKey
GET /api/ipam/dnssec/keys/{id}/ds_records/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Responses: 200 → DNSSECKey
POST /api/ipam/dnssec/keys/{id}/retire/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Request body (application/json): DNSSECKeyRequest
Responses: 200 → DNSSECKey
POST /api/ipam/dnssec/keys/{id}/revoke/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Request body (application/json): DNSSECKeyRequest
Responses: 200 → DNSSECKey
POST /api/ipam/dnssec/keys/{id}/rollover/Pre-publish rollover: generate a new key of the same type, retire current.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec key. |
Request body (application/json): DNSSECKeyRequest
Responses: 200 → DNSSECKey
GET /api/ipam/dnssec/policies/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
enabled | query | no | boolean | |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
zone | query | no | integer |
Responses: 200 → PaginatedDNSSECPolicyList
POST /api/ipam/dnssec/policies/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): DNSSECPolicyRequest
Responses: 201 → DNSSECPolicy
GET /api/ipam/dnssec/policies/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Responses: 200 → DNSSECPolicy
PUT /api/ipam/dnssec/policies/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Request body (application/json): DNSSECPolicyRequest
Responses: 200 → DNSSECPolicy
PATCH /api/ipam/dnssec/policies/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Request body (application/json): PatchedDNSSECPolicyRequest
Responses: 200 → DNSSECPolicy
DELETE /api/ipam/dnssec/policies/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Responses: 204
POST /api/ipam/dnssec/policies/{id}/disable/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Request body (application/json): DNSSECPolicyRequest
Responses: 200 → DNSSECPolicy
GET /api/ipam/dnssec/policies/{id}/ds_records/Return DS records for all active KSKs (to submit to parent zone/registrar).
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Responses: 200 → DNSSECPolicy
POST /api/ipam/dnssec/policies/{id}/enable/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Request body (application/json): DNSSECPolicyRequest
Responses: 200 → DNSSECPolicy
POST /api/ipam/dnssec/policies/{id}/generate_keys/Generate a new ZSK+KSK pair for the zone using the configured algorithm.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Request body (application/json): DNSSECPolicyRequest
Responses: 200 → DNSSECPolicy
POST /api/ipam/dnssec/policies/{id}/sign_zone/Sign all RRsets in the zone and write RRSIG/DNSKEY/NSEC3 records.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this dnssec policy. |
Request body (application/json): DNSSECPolicyRequest
Responses: 200 → DNSSECPolicy
GET /api/ipam/networks/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
container | query | no | integer | |
dhcp_enabled | query | no | boolean | |
network_view | query | no | integer | |
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
site | query | no | string | |
status | query | no | string | * active - Active |
vlan_id | query | no | integer |
Responses: 200 → PaginatedNetworkListList
POST /api/ipam/networks/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): NetworkRequest
Responses: 201 → Network
GET /api/ipam/networks/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Responses: 200 → Network
PUT /api/ipam/networks/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Request body (application/json): NetworkRequest
Responses: 200 → Network
PATCH /api/ipam/networks/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Request body (application/json): PatchedNetworkRequest
Responses: 200 → Network
DELETE /api/ipam/networks/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Responses: 204
GET /api/ipam/networks/{id}/all_ips/Return every host IP in the subnet — allocated records merged with free slots.
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Responses: 200 → Network
POST /api/ipam/networks/{id}/bulk_add/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Request body (application/json): NetworkRequest
Responses: 200 → Network
GET /api/ipam/networks/{id}/ips/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Responses: 200 → Network
GET /api/ipam/networks/{id}/next_available/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network. |
Responses: 200 → Network
GET /api/ipam/stats/List stats
Responses: 200
GET /api/ipam/views/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedNetworkViewList
POST /api/ipam/views/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): NetworkViewRequest
Responses: 201 → NetworkView
GET /api/ipam/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network view. |
Responses: 200 → NetworkView
PUT /api/ipam/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network view. |
Request body (application/json): NetworkViewRequest
Responses: 200 → NetworkView
PATCH /api/ipam/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network view. |
Request body (application/json): PatchedNetworkViewRequest
Responses: 200 → NetworkView
DELETE /api/ipam/views/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | A unique integer value identifying this network view. |
Responses: 204
Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.