{ "openapi": "3.0.3", "info": { "title": "IPAM / DDI API", "version": "1.0.0", "description": "IP address management and DNS/DHCP (DDI)." }, "servers": [ { "url": "https://versus-demo.com" } ], "paths": { "/api/ipam/addresses/": { "get": { "operationId": "ipam_addresses_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "network", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "deprecated", "dhcp", "free", "reserved", "used" ] }, "description": "* `free` - Free\n* `used` - Used\n* `reserved` - Reserved\n* `dhcp` - DHCP\n* `deprecated` - Deprecated" } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedIPAddressList" } } }, "description": "" } }, "summary": "List addresss" }, "post": { "operationId": "ipam_addresses_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAddressRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IPAddressRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IPAddressRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAddress" } } }, "description": "" } }, "summary": "Create address" } }, "/api/ipam/addresses/{id}/": { "get": { "operationId": "ipam_addresses_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ip address.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAddress" } } }, "description": "" } }, "summary": "Retrieve address" }, "put": { "operationId": "ipam_addresses_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "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/IPAddressRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IPAddressRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IPAddressRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAddress" } } }, "description": "" } }, "summary": "Update address" }, "patch": { "operationId": "ipam_addresses_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "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/PatchedIPAddressRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedIPAddressRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedIPAddressRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAddress" } } }, "description": "" } }, "summary": "Update address" }, "delete": { "operationId": "ipam_addresses_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ip address.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete address" } }, "/api/ipam/containers/": { "get": { "operationId": "ipam_containers_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "network_view", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNetworkContainerList" } } }, "description": "" } }, "summary": "List containers" }, "post": { "operationId": "ipam_containers_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkContainerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkContainerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkContainerRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkContainer" } } }, "description": "" } }, "summary": "Create container" } }, "/api/ipam/containers/{id}/": { "get": { "operationId": "ipam_containers_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network container.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkContainer" } } }, "description": "" } }, "summary": "Retrieve container" }, "put": { "operationId": "ipam_containers_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network container.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkContainerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkContainerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkContainerRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkContainer" } } }, "description": "" } }, "summary": "Update container" }, "patch": { "operationId": "ipam_containers_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network container.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNetworkContainerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNetworkContainerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNetworkContainerRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkContainer" } } }, "description": "" } }, "summary": "Update container" }, "delete": { "operationId": "ipam_containers_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network container.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete container" } }, "/api/ipam/dhcp-leases/": { "get": { "operationId": "ipam_dhcp_leases_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "binding_state", "schema": { "type": "string" } }, { "in": "query", "name": "network", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDHCPLeaseList" } } }, "description": "" } }, "summary": "List dhcp leases" }, "post": { "operationId": "ipam_dhcp_leases_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPLeaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DHCPLeaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DHCPLeaseRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPLease" } } }, "description": "" } }, "summary": "Create dhcp lease" } }, "/api/ipam/dhcp-leases/{id}/": { "get": { "operationId": "ipam_dhcp_leases_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp lease.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPLease" } } }, "description": "" } }, "summary": "Retrieve dhcp lease" }, "put": { "operationId": "ipam_dhcp_leases_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp lease.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPLeaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DHCPLeaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DHCPLeaseRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPLease" } } }, "description": "" } }, "summary": "Update dhcp lease" }, "patch": { "operationId": "ipam_dhcp_leases_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp lease.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDHCPLeaseRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDHCPLeaseRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDHCPLeaseRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPLease" } } }, "description": "" } }, "summary": "Update dhcp lease" }, "delete": { "operationId": "ipam_dhcp_leases_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp lease.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete dhcp lease" } }, "/api/ipam/dhcp-ranges/": { "get": { "operationId": "ipam_dhcp_ranges_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "is_active", "schema": { "type": "boolean" } }, { "in": "query", "name": "network", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDHCPRangeList" } } }, "description": "" } }, "summary": "List dhcp ranges" }, "post": { "operationId": "ipam_dhcp_ranges_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPRangeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DHCPRangeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DHCPRangeRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPRange" } } }, "description": "" } }, "summary": "Create dhcp range" } }, "/api/ipam/dhcp-ranges/{id}/": { "get": { "operationId": "ipam_dhcp_ranges_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp range.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPRange" } } }, "description": "" } }, "summary": "Retrieve dhcp range" }, "put": { "operationId": "ipam_dhcp_ranges_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp range.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPRangeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DHCPRangeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DHCPRangeRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPRange" } } }, "description": "" } }, "summary": "Update dhcp range" }, "patch": { "operationId": "ipam_dhcp_ranges_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp range.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDHCPRangeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDHCPRangeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDHCPRangeRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DHCPRange" } } }, "description": "" } }, "summary": "Update dhcp range" }, "delete": { "operationId": "ipam_dhcp_ranges_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dhcp range.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete dhcp range" } }, "/api/ipam/dns/records/": { "get": { "operationId": "ipam_dns_records_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "auto_created", "schema": { "type": "boolean" } }, { "in": "query", "name": "disabled", "schema": { "type": "boolean" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "record_type", "schema": { "type": "string", "enum": [ "A", "AAAA", "CAA", "CNAME", "DNSKEY", "DS", "MX", "NAPTR", "NS", "NSEC3", "NSEC3PARAM", "PTR", "RRSIG", "SRV", "TXT" ] }, "description": "* `A` - A\n* `AAAA` - AAAA\n* `CNAME` - CNAME\n* `MX` - MX\n* `PTR` - PTR\n* `TXT` - TXT\n* `SRV` - SRV\n* `NS` - NS\n* `NAPTR` - NAPTR\n* `CAA` - CAA\n* `DNSKEY` - DNSKEY\n* `RRSIG` - RRSIG\n* `NSEC3` - NSEC3\n* `NSEC3PARAM` - NSEC3PARAM\n* `DS` - DS" }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } }, { "in": "query", "name": "zone", "schema": { "type": "integer" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDNSRecordList" } } }, "description": "" } }, "summary": "List records" }, "post": { "operationId": "ipam_dns_records_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSRecordRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSRecordRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSRecordRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSRecord" } } }, "description": "" } }, "summary": "Create record" } }, "/api/ipam/dns/records/{id}/": { "get": { "operationId": "ipam_dns_records_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns record.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSRecord" } } }, "description": "" } }, "summary": "Retrieve record" }, "put": { "operationId": "ipam_dns_records_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns record.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSRecordRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSRecordRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSRecordRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSRecord" } } }, "description": "" } }, "summary": "Update record" }, "patch": { "operationId": "ipam_dns_records_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns record.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDNSRecordRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDNSRecordRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDNSRecordRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSRecord" } } }, "description": "" } }, "summary": "Update record" }, "delete": { "operationId": "ipam_dns_records_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns record.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete record" } }, "/api/ipam/dns/servers/": { "get": { "operationId": "ipam_dns_servers_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDNSServerList" } } }, "description": "" } }, "summary": "List servers" }, "post": { "operationId": "ipam_dns_servers_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServer" } } }, "description": "" } }, "summary": "Create server" } }, "/api/ipam/dns/servers/{id}/": { "get": { "operationId": "ipam_dns_servers_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns server.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServer" } } }, "description": "" } }, "summary": "Retrieve server" }, "put": { "operationId": "ipam_dns_servers_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns server.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServer" } } }, "description": "" } }, "summary": "Update server" }, "patch": { "operationId": "ipam_dns_servers_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns server.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDNSServerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDNSServerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDNSServerRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServer" } } }, "description": "" } }, "summary": "Update server" }, "delete": { "operationId": "ipam_dns_servers_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns server.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete server" } }, "/api/ipam/dns/servers/{id}/test_notify/": { "post": { "operationId": "ipam_dns_servers_test_notify_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns server.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSServerRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSServer" } } }, "description": "" } }, "summary": "Test notify: server" } }, "/api/ipam/dns/views/": { "get": { "operationId": "ipam_dns_views_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDNSViewList" } } }, "description": "" } }, "summary": "List views" }, "post": { "operationId": "ipam_dns_views_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSViewRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSViewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSViewRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSView" } } }, "description": "" } }, "summary": "Create view" } }, "/api/ipam/dns/views/{id}/": { "get": { "operationId": "ipam_dns_views_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns view.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSView" } } }, "description": "" } }, "summary": "Retrieve view" }, "put": { "operationId": "ipam_dns_views_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns view.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSViewRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSViewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSViewRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSView" } } }, "description": "" } }, "summary": "Update view" }, "patch": { "operationId": "ipam_dns_views_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns view.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDNSViewRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDNSViewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDNSViewRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSView" } } }, "description": "" } }, "summary": "Update view" }, "delete": { "operationId": "ipam_dns_views_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns view.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete view" } }, "/api/ipam/dns/zones/": { "get": { "operationId": "ipam_dns_zones_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "is_locked", "schema": { "type": "boolean" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } }, { "in": "query", "name": "view", "schema": { "type": "integer" } }, { "in": "query", "name": "zone_type", "schema": { "type": "string", "enum": [ "delegation", "forward", "reverse", "stub" ] }, "description": "* `forward` - Forward\n* `reverse` - Reverse\n* `stub` - Stub\n* `delegation` - Delegation" } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDNSZoneList" } } }, "description": "" } }, "summary": "List zones" }, "post": { "operationId": "ipam_dns_zones_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Create zone" } }, "/api/ipam/dns/zones/{id}/": { "get": { "operationId": "ipam_dns_zones_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Retrieve zone" }, "put": { "operationId": "ipam_dns_zones_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Update zone" }, "patch": { "operationId": "ipam_dns_zones_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDNSZoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDNSZoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDNSZoneRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Update zone" }, "delete": { "operationId": "ipam_dns_zones_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete zone" } }, "/api/ipam/dns/zones/{id}/bump_serial/": { "post": { "operationId": "ipam_dns_zones_bump_serial_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Bump serial: zone" } }, "/api/ipam/dns/zones/{id}/notify/": { "post": { "operationId": "ipam_dns_zones_notify_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSZoneRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Notify: zone" } }, "/api/ipam/dns/zones/{id}/zonefile/": { "get": { "operationId": "ipam_dns_zones_zonefile_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dns zone.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSZone" } } }, "description": "" } }, "summary": "Zonefile: zone" } }, "/api/ipam/dnssec/keys/": { "get": { "operationId": "ipam_dnssec_keys_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "key_type", "schema": { "type": "string", "enum": [ "KSK", "ZSK" ] }, "description": "* `ZSK` - Zone Signing Key\n* `KSK` - Key Signing Key" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "state", "schema": { "type": "string", "enum": [ "active", "generated", "published", "retired", "retiring", "revoked" ] }, "description": "* `generated` - Generated\n* `published` - Published\n* `active` - Active\n* `retiring` - Retiring\n* `retired` - Retired\n* `revoked` - Revoked" }, { "in": "query", "name": "zone", "schema": { "type": "integer" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDNSSECKeyList" } } }, "description": "" } }, "summary": "List keys" }, "post": { "operationId": "ipam_dnssec_keys_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Create key" } }, "/api/ipam/dnssec/keys/{id}/": { "get": { "operationId": "ipam_dnssec_keys_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Retrieve key" }, "put": { "operationId": "ipam_dnssec_keys_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Update key" }, "patch": { "operationId": "ipam_dnssec_keys_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDNSSECKeyRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Update key" }, "delete": { "operationId": "ipam_dnssec_keys_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete key" } }, "/api/ipam/dnssec/keys/{id}/activate/": { "post": { "operationId": "ipam_dnssec_keys_activate_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Activate: key" } }, "/api/ipam/dnssec/keys/{id}/ds_records/": { "get": { "operationId": "ipam_dnssec_keys_ds_records_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Ds records: key" } }, "/api/ipam/dnssec/keys/{id}/retire/": { "post": { "operationId": "ipam_dnssec_keys_retire_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Retire: key" } }, "/api/ipam/dnssec/keys/{id}/revoke/": { "post": { "operationId": "ipam_dnssec_keys_revoke_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Revoke: key" } }, "/api/ipam/dnssec/keys/{id}/rollover/": { "post": { "operationId": "ipam_dnssec_keys_rollover_create", "description": "Pre-publish rollover: generate a new key of the same type, retire current.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec key.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECKeyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECKey" } } }, "description": "" } }, "summary": "Rollover: key" } }, "/api/ipam/dnssec/policies/": { "get": { "operationId": "ipam_dnssec_policies_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "zone", "schema": { "type": "integer" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDNSSECPolicyList" } } }, "description": "" } }, "summary": "List policys" }, "post": { "operationId": "ipam_dnssec_policies_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Create policy" } }, "/api/ipam/dnssec/policies/{id}/": { "get": { "operationId": "ipam_dnssec_policies_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Retrieve policy" }, "put": { "operationId": "ipam_dnssec_policies_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Update policy" }, "patch": { "operationId": "ipam_dnssec_policies_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDNSSECPolicyRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Update policy" }, "delete": { "operationId": "ipam_dnssec_policies_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete policy" } }, "/api/ipam/dnssec/policies/{id}/disable/": { "post": { "operationId": "ipam_dnssec_policies_disable_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Disable: policy" } }, "/api/ipam/dnssec/policies/{id}/ds_records/": { "get": { "operationId": "ipam_dnssec_policies_ds_records_retrieve", "description": "Return DS records for all active KSKs (to submit to parent zone/registrar).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Ds records: policy" } }, "/api/ipam/dnssec/policies/{id}/enable/": { "post": { "operationId": "ipam_dnssec_policies_enable_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Enable: policy" } }, "/api/ipam/dnssec/policies/{id}/generate_keys/": { "post": { "operationId": "ipam_dnssec_policies_generate_keys_create", "description": "Generate a new ZSK+KSK pair for the zone using the configured algorithm.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Generate keys: policy" } }, "/api/ipam/dnssec/policies/{id}/sign_zone/": { "post": { "operationId": "ipam_dnssec_policies_sign_zone_create", "description": "Sign all RRsets in the zone and write RRSIG/DNSKEY/NSEC3 records.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this dnssec policy.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DNSSECPolicyRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNSSECPolicy" } } }, "description": "" } }, "summary": "Sign zone: policy" } }, "/api/ipam/networks/": { "get": { "operationId": "ipam_networks_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "query", "name": "container", "schema": { "type": "integer" } }, { "in": "query", "name": "dhcp_enabled", "schema": { "type": "boolean" } }, { "in": "query", "name": "network_view", "schema": { "type": "integer" } }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } }, { "in": "query", "name": "site", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "active", "deprecated", "reserved" ] }, "description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated" }, { "in": "query", "name": "vlan_id", "schema": { "type": "integer" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNetworkListList" } } }, "description": "" } }, "summary": "List networks" }, "post": { "operationId": "ipam_networks_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Create network" } }, "/api/ipam/networks/{id}/": { "get": { "operationId": "ipam_networks_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Retrieve network" }, "put": { "operationId": "ipam_networks_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Update network" }, "patch": { "operationId": "ipam_networks_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNetworkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNetworkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNetworkRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Update network" }, "delete": { "operationId": "ipam_networks_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete network" } }, "/api/ipam/networks/{id}/all_ips/": { "get": { "operationId": "ipam_networks_all_ips_retrieve", "description": "Return every host IP in the subnet \u2014 allocated records merged with free slots.\nCapped at 1024 addresses so /8 blocks don't blow up the response.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "All ips: network" } }, "/api/ipam/networks/{id}/bulk_add/": { "post": { "operationId": "ipam_networks_bulk_add_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Bulk add: network" } }, "/api/ipam/networks/{id}/ips/": { "get": { "operationId": "ipam_networks_ips_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Ips: network" } }, "/api/ipam/networks/{id}/next_available/": { "get": { "operationId": "ipam_networks_next_available_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } }, "description": "" } }, "summary": "Next available: network" } }, "/api/ipam/stats/": { "get": { "operationId": "ipam_stats_retrieve", "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "List stats" } }, "/api/ipam/views/": { "get": { "operationId": "ipam_views_list", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNetworkViewList" } } }, "description": "" } }, "summary": "List views" }, "post": { "operationId": "ipam_views_create", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkViewRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkViewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkViewRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkView" } } }, "description": "" } }, "summary": "Create view" } }, "/api/ipam/views/{id}/": { "get": { "operationId": "ipam_views_retrieve", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network view.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkView" } } }, "description": "" } }, "summary": "Retrieve view" }, "put": { "operationId": "ipam_views_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network view.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkViewRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetworkViewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetworkViewRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkView" } } }, "description": "" } }, "summary": "Update view" }, "patch": { "operationId": "ipam_views_partial_update", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network view.", "required": true } ], "tags": [ "ipam" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNetworkViewRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNetworkViewRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNetworkViewRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkView" } } }, "description": "" } }, "summary": "Update view" }, "delete": { "operationId": "ipam_views_destroy", "description": "Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated\n(VS-SPEC-TENANT-IDENTITY-001 \u00a714). Use as the FIRST base:\n\n class DeviceViewSet(TenantScopedModelViewSet, viewsets.ModelViewSet):\n queryset = Device.objects.select_related(...)\n ...\n\nUnlike the strict TenantScopedViewSet pilot, this **degrades gracefully**:\nit is INERT unless the tenant_scoped alias is configured\n(TENANT_SCOPED_DATABASE_URL) AND the request carries a tenant_id claim.\nWhen inert it behaves exactly like a plain ModelViewSet \u2014 so the rollout\nlands additively and isolation switches on only once the non-superuser\nPostgres role exists (mirrors tenant_subdomain.py's \"inert unless\nconfigured\" contract). When active: reads route through the RLS-enforcing\nconnection and tenant_id is stamped server-side (never client input).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this network view.", "required": true } ], "tags": [ "ipam" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete view" } } }, "components": { "schemas": { "NetworkViewRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "description": { "type": "string" }, "is_default": { "type": "boolean" } }, "required": [ "name" ] }, "NetworkList": { "type": "object", "description": "Lighter serializer for list views (no per-ip counts on large data).", "properties": { "id": { "type": "integer", "readOnly": true }, "cidr": { "type": "string", "maxLength": 43 }, "name": { "type": "string", "maxLength": 128 }, "description": { "type": "string", "maxLength": 256 }, "site": { "type": "string", "maxLength": 128 }, "vlan_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "gateway": { "type": "string", "nullable": true }, "dns_domain": { "type": "string", "maxLength": 255 }, "dhcp_enabled": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/Status638Enum" }, "utilization": { "type": "number", "format": "double" }, "network_view": { "type": "integer" }, "network_view_name": { "type": "string", "readOnly": true }, "container": { "type": "integer", "nullable": true }, "container_cidr": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "cidr", "container_cidr", "created_at", "id", "network_view", "network_view_name", "updated_at" ] }, "PaginatedDNSSECPolicyList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DNSSECPolicy" } } } }, "DNSSECKey": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "zone_fqdn": { "type": "string", "readOnly": true }, "days_until_expiry": { "type": "string", "readOnly": true }, "is_expired": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "key_type": { "$ref": "#/components/schemas/DNSSECKeyKeyTypeEnum" }, "algorithm": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "algorithm_name": { "type": "string", "maxLength": 32 }, "key_tag": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "flags": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "protocol": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "public_key": { "type": "string" }, "state": { "$ref": "#/components/schemas/DNSSECKeyStateEnum" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "retired_at": { "type": "string", "format": "date-time", "nullable": true }, "zone": { "type": "integer" } }, "required": [ "algorithm", "created_at", "days_until_expiry", "flags", "id", "is_expired", "key_tag", "key_type", "public_key", "zone", "zone_fqdn" ] }, "DHCPRangeRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "start_ip": { "type": "string", "minLength": 1 }, "end_ip": { "type": "string", "minLength": 1 }, "comment": { "type": "string", "maxLength": 256 }, "is_active": { "type": "boolean" }, "network": { "type": "integer" } }, "required": [ "end_ip", "network", "start_ip" ] }, "PatchedDNSViewRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "recursion_enabled": { "type": "boolean" } } }, "DNSSECPolicy": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "algorithm_name": { "type": "string", "readOnly": true }, "zone_fqdn": { "type": "string", "readOnly": true }, "days_until_resign": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "algorithm": { "allOf": [ { "$ref": "#/components/schemas/AlgorithmEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "zsk_bits": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "RSA key size (ignored for ECDSA/Ed)" }, "ksk_bits": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "RSA key size (ignored for ECDSA/Ed)" }, "signature_validity_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "zsk_lifetime_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "ksk_lifetime_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "nsec3_enabled": { "type": "boolean" }, "nsec3_iterations": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "nsec3_salt_length": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "last_signed": { "type": "string", "format": "date-time", "nullable": true }, "next_resign": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "zone": { "type": "integer" } }, "required": [ "algorithm_name", "created_at", "days_until_resign", "id", "updated_at", "zone", "zone_fqdn" ] }, "DNSServerRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "ip_address": { "type": "string", "minLength": 1 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "tsig_key_name": { "type": "string", "maxLength": 128 }, "tsig_key": { "type": "string", "maxLength": 512 }, "tsig_algorithm": { "type": "string", "maxLength": 64 }, "is_active": { "type": "boolean" }, "last_notified": { "type": "string", "format": "date-time", "nullable": true }, "device": { "type": "integer", "nullable": true }, "zones": { "type": "array", "items": { "type": "integer" } } }, "required": [ "ip_address", "name" ] }, "PatchedDNSZoneRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "fqdn": { "type": "string", "minLength": 1, "maxLength": 255 }, "zone_type": { "$ref": "#/components/schemas/ZoneTypeEnum" }, "primary_ns": { "type": "string", "minLength": 1, "maxLength": 255 }, "admin_email": { "type": "string", "minLength": 1, "maxLength": 255 }, "serial": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "refresh": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "retry": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "expire": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "minimum_ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "default_ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "is_locked": { "type": "boolean" }, "description": { "type": "string", "maxLength": 256 }, "view": { "type": "integer" } } }, "PaginatedDNSViewList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DNSView" } } } }, "PaginatedNetworkContainerList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkContainer" } } } }, "DNSView": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "zone_count": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "maxLength": 64 }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "recursion_enabled": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "zone_count" ] }, "PatchedNetworkRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "cidr": { "type": "string", "minLength": 1, "maxLength": 43 }, "name": { "type": "string", "maxLength": 128 }, "description": { "type": "string", "maxLength": 256 }, "site": { "type": "string", "maxLength": 128 }, "vlan_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "gateway": { "type": "string", "nullable": true, "minLength": 1 }, "dns_domain": { "type": "string", "maxLength": 255 }, "dhcp_enabled": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/Status638Enum" }, "custom_fields": {}, "utilization": { "type": "number", "format": "double" }, "network_view": { "type": "integer" }, "container": { "type": "integer", "nullable": true } } }, "PatchedDNSServerRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "ip_address": { "type": "string", "minLength": 1 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "tsig_key_name": { "type": "string", "maxLength": 128 }, "tsig_key": { "type": "string", "maxLength": 512 }, "tsig_algorithm": { "type": "string", "maxLength": 64 }, "is_active": { "type": "boolean" }, "last_notified": { "type": "string", "format": "date-time", "nullable": true }, "device": { "type": "integer", "nullable": true }, "zones": { "type": "array", "items": { "type": "integer" } } } }, "DHCPLeaseRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "address": { "type": "string", "minLength": 1 }, "mac_address": { "type": "string", "minLength": 1, "maxLength": 17 }, "hostname": { "type": "string", "maxLength": 255 }, "binding_state": { "type": "string", "minLength": 1, "maxLength": 20 }, "starts": { "type": "string", "format": "date-time", "nullable": true }, "ends": { "type": "string", "format": "date-time", "nullable": true }, "network": { "type": "integer" } }, "required": [ "address", "mac_address", "network" ] }, "PaginatedDHCPRangeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DHCPRange" } } } }, "NetworkContainer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "network_count": { "type": "string", "readOnly": true }, "network_view_name": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "cidr": { "type": "string", "maxLength": 43 }, "description": { "type": "string", "maxLength": 256 }, "custom_fields": {}, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "network_view": { "type": "integer" } }, "required": [ "cidr", "created_at", "id", "network_count", "network_view", "network_view_name" ] }, "PatchedDNSRecordRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "description": "Relative to zone; '@' for apex", "maxLength": 255 }, "record_type": { "$ref": "#/components/schemas/DNSRecordRecordTypeEnum" }, "ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "value": { "type": "string", "minLength": 1 }, "priority": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "weight": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "rdata_extra": {}, "comment": { "type": "string", "maxLength": 256 }, "disabled": { "type": "boolean" }, "auto_created": { "type": "boolean" }, "zone": { "type": "integer" } } }, "PatchedNetworkContainerRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "cidr": { "type": "string", "minLength": 1, "maxLength": 43 }, "description": { "type": "string", "maxLength": 256 }, "custom_fields": {}, "network_view": { "type": "integer" } } }, "DNSSECKeyStateEnum": { "enum": [ "generated", "published", "active", "retiring", "retired", "revoked" ], "type": "string", "description": "* `generated` - Generated\n* `published` - Published\n* `active` - Active\n* `retiring` - Retiring\n* `retired` - Retired\n* `revoked` - Revoked" }, "PaginatedDNSServerList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DNSServer" } } } }, "PaginatedDNSZoneList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DNSZone" } } } }, "DNSRecordRecordTypeEnum": { "enum": [ "A", "AAAA", "CNAME", "MX", "PTR", "TXT", "SRV", "NS", "NAPTR", "CAA", "DNSKEY", "RRSIG", "NSEC3", "NSEC3PARAM", "DS" ], "type": "string", "description": "* `A` - A\n* `AAAA` - AAAA\n* `CNAME` - CNAME\n* `MX` - MX\n* `PTR` - PTR\n* `TXT` - TXT\n* `SRV` - SRV\n* `NS` - NS\n* `NAPTR` - NAPTR\n* `CAA` - CAA\n* `DNSKEY` - DNSKEY\n* `RRSIG` - RRSIG\n* `NSEC3` - NSEC3\n* `NSEC3PARAM` - NSEC3PARAM\n* `DS` - DS" }, "PatchedNetworkViewRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "description": { "type": "string" }, "is_default": { "type": "boolean" } } }, "PaginatedNetworkListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkList" } } } }, "NetworkContainerRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "cidr": { "type": "string", "minLength": 1, "maxLength": 43 }, "description": { "type": "string", "maxLength": 256 }, "custom_fields": {}, "network_view": { "type": "integer" } }, "required": [ "cidr", "network_view" ] }, "AlgorithmEnum": { "enum": [ 8, 10, 13, 14, 15, 16 ], "type": "integer", "description": "* `8` - RSASHA256\n* `10` - RSASHA512\n* `13` - ECDSAP256SHA256\n* `14` - ECDSAP384SHA384\n* `15` - ED25519\n* `16` - ED448" }, "PatchedDHCPLeaseRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "address": { "type": "string", "minLength": 1 }, "mac_address": { "type": "string", "minLength": 1, "maxLength": 17 }, "hostname": { "type": "string", "maxLength": 255 }, "binding_state": { "type": "string", "minLength": 1, "maxLength": 20 }, "starts": { "type": "string", "format": "date-time", "nullable": true }, "ends": { "type": "string", "format": "date-time", "nullable": true }, "network": { "type": "integer" } } }, "Status638Enum": { "enum": [ "active", "reserved", "deprecated" ], "type": "string", "description": "* `active` - Active\n* `reserved` - Reserved\n* `deprecated` - Deprecated" }, "PaginatedDHCPLeaseList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DHCPLease" } } } }, "DNSServer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "device_name": { "type": "string", "readOnly": true }, "zone_count": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "maxLength": 128 }, "ip_address": { "type": "string" }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "tsig_key_name": { "type": "string", "maxLength": 128 }, "tsig_key": { "type": "string", "maxLength": 512 }, "tsig_algorithm": { "type": "string", "maxLength": 64 }, "is_active": { "type": "boolean" }, "last_notified": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "device": { "type": "integer", "nullable": true }, "zones": { "type": "array", "items": { "type": "integer" } } }, "required": [ "created_at", "device_name", "id", "ip_address", "name", "zone_count" ] }, "Network": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "network_view_name": { "type": "string", "readOnly": true }, "container_cidr": { "type": "string", "readOnly": true }, "ip_count": { "type": "string", "readOnly": true }, "total_ips": { "type": "string", "readOnly": true }, "used_ips": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "cidr": { "type": "string", "maxLength": 43 }, "name": { "type": "string", "maxLength": 128 }, "description": { "type": "string", "maxLength": 256 }, "site": { "type": "string", "maxLength": 128 }, "vlan_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "gateway": { "type": "string", "nullable": true }, "dns_domain": { "type": "string", "maxLength": 255 }, "dhcp_enabled": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/Status638Enum" }, "custom_fields": {}, "utilization": { "type": "number", "format": "double" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "network_view": { "type": "integer" }, "container": { "type": "integer", "nullable": true } }, "required": [ "cidr", "container_cidr", "created_at", "id", "ip_count", "network_view", "network_view_name", "total_ips", "updated_at", "used_ips" ] }, "PaginatedDNSSECKeyList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DNSSECKey" } } } }, "PatchedDHCPRangeRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "start_ip": { "type": "string", "minLength": 1 }, "end_ip": { "type": "string", "minLength": 1 }, "comment": { "type": "string", "maxLength": 256 }, "is_active": { "type": "boolean" }, "network": { "type": "integer" } } }, "DNSZoneRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "fqdn": { "type": "string", "minLength": 1, "maxLength": 255 }, "zone_type": { "$ref": "#/components/schemas/ZoneTypeEnum" }, "primary_ns": { "type": "string", "minLength": 1, "maxLength": 255 }, "admin_email": { "type": "string", "minLength": 1, "maxLength": 255 }, "serial": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "refresh": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "retry": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "expire": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "minimum_ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "default_ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "is_locked": { "type": "boolean" }, "description": { "type": "string", "maxLength": 256 }, "view": { "type": "integer" } }, "required": [ "fqdn", "view" ] }, "DNSRecord": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "zone_fqdn": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Relative to zone; '@' for apex", "maxLength": 255 }, "record_type": { "$ref": "#/components/schemas/DNSRecordRecordTypeEnum" }, "ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "value": { "type": "string" }, "priority": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "weight": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "rdata_extra": {}, "comment": { "type": "string", "maxLength": 256 }, "disabled": { "type": "boolean" }, "auto_created": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "zone": { "type": "integer" } }, "required": [ "created_at", "id", "name", "record_type", "updated_at", "value", "zone", "zone_fqdn" ] }, "DHCPRange": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "network_cidr": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "start_ip": { "type": "string" }, "end_ip": { "type": "string" }, "comment": { "type": "string", "maxLength": 256 }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "network": { "type": "integer" } }, "required": [ "created_at", "end_ip", "id", "network", "network_cidr", "start_ip" ] }, "NetworkRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "cidr": { "type": "string", "minLength": 1, "maxLength": 43 }, "name": { "type": "string", "maxLength": 128 }, "description": { "type": "string", "maxLength": 256 }, "site": { "type": "string", "maxLength": 128 }, "vlan_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "gateway": { "type": "string", "nullable": true, "minLength": 1 }, "dns_domain": { "type": "string", "maxLength": 255 }, "dhcp_enabled": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/Status638Enum" }, "custom_fields": {}, "utilization": { "type": "number", "format": "double" }, "network_view": { "type": "integer" }, "container": { "type": "integer", "nullable": true } }, "required": [ "cidr", "network_view" ] }, "DHCPLease": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "network_cidr": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "address": { "type": "string" }, "mac_address": { "type": "string", "maxLength": 17 }, "hostname": { "type": "string", "maxLength": 255 }, "binding_state": { "type": "string", "maxLength": 20 }, "starts": { "type": "string", "format": "date-time", "nullable": true }, "ends": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "network": { "type": "integer" } }, "required": [ "address", "created_at", "id", "mac_address", "network", "network_cidr" ] }, "NetworkView": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "network_count": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "maxLength": 64 }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "network_count" ] }, "DNSViewRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 64 }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "recursion_enabled": { "type": "boolean" } }, "required": [ "name" ] }, "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/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/IPAddress" } } } }, "IPAddress": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "network_cidr": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "address": { "type": "string" }, "hostname": { "type": "string", "maxLength": 255 }, "mac_address": { "type": "string", "maxLength": 17 }, "status": { "$ref": "#/components/schemas/IPAddressStatusEnum" }, "description": { "type": "string", "maxLength": 256 }, "dns_name": { "type": "string", "maxLength": 255 }, "interface": { "type": "string", "maxLength": 128 }, "last_seen": { "type": "string", "format": "date-time", "nullable": true }, "custom_fields": {}, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "network": { "type": "integer" } }, "required": [ "address", "created_at", "id", "network", "network_cidr", "updated_at" ] }, "IPAddressStatusEnum": { "enum": [ "free", "used", "reserved", "dhcp", "deprecated" ], "type": "string", "description": "* `free` - Free\n* `used` - Used\n* `reserved` - Reserved\n* `dhcp` - DHCP\n* `deprecated` - Deprecated" }, "ZoneTypeEnum": { "enum": [ "forward", "reverse", "stub", "delegation" ], "type": "string", "description": "* `forward` - Forward\n* `reverse` - Reverse\n* `stub` - Stub\n* `delegation` - Delegation" }, "PaginatedDNSRecordList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DNSRecord" } } } }, "DNSSECKeyRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "key_type": { "$ref": "#/components/schemas/DNSSECKeyKeyTypeEnum" }, "algorithm": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "algorithm_name": { "type": "string", "maxLength": 32 }, "key_tag": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "flags": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "protocol": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "public_key": { "type": "string", "minLength": 1 }, "private_key_pem": { "type": "string", "writeOnly": true, "minLength": 1 }, "state": { "$ref": "#/components/schemas/DNSSECKeyStateEnum" }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "retired_at": { "type": "string", "format": "date-time", "nullable": true }, "zone": { "type": "integer" } }, "required": [ "algorithm", "flags", "key_tag", "key_type", "private_key_pem", "public_key", "zone" ] }, "DNSSECPolicyRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "algorithm": { "allOf": [ { "$ref": "#/components/schemas/AlgorithmEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "zsk_bits": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "RSA key size (ignored for ECDSA/Ed)" }, "ksk_bits": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "RSA key size (ignored for ECDSA/Ed)" }, "signature_validity_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "zsk_lifetime_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "ksk_lifetime_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "nsec3_enabled": { "type": "boolean" }, "nsec3_iterations": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "nsec3_salt_length": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "last_signed": { "type": "string", "format": "date-time", "nullable": true }, "next_resign": { "type": "string", "format": "date-time", "nullable": true }, "zone": { "type": "integer" } }, "required": [ "zone" ] }, "DNSSECKeyKeyTypeEnum": { "enum": [ "ZSK", "KSK" ], "type": "string", "description": "* `ZSK` - Zone Signing Key\n* `KSK` - Key Signing Key" }, "PaginatedNetworkViewList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkView" } } } }, "PatchedDNSSECPolicyRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "enabled": { "type": "boolean" }, "algorithm": { "allOf": [ { "$ref": "#/components/schemas/AlgorithmEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "zsk_bits": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "RSA key size (ignored for ECDSA/Ed)" }, "ksk_bits": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "RSA key size (ignored for ECDSA/Ed)" }, "signature_validity_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "zsk_lifetime_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "ksk_lifetime_days": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "nsec3_enabled": { "type": "boolean" }, "nsec3_iterations": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "nsec3_salt_length": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "last_signed": { "type": "string", "format": "date-time", "nullable": true }, "next_resign": { "type": "string", "format": "date-time", "nullable": true }, "zone": { "type": "integer" } } }, "IPAddressRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "address": { "type": "string", "minLength": 1 }, "hostname": { "type": "string", "maxLength": 255 }, "mac_address": { "type": "string", "maxLength": 17 }, "status": { "$ref": "#/components/schemas/IPAddressStatusEnum" }, "description": { "type": "string", "maxLength": 256 }, "dns_name": { "type": "string", "maxLength": 255 }, "interface": { "type": "string", "maxLength": 128 }, "last_seen": { "type": "string", "format": "date-time", "nullable": true }, "custom_fields": {}, "network": { "type": "integer" } }, "required": [ "address", "network" ] }, "DNSZone": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "view_name": { "type": "string", "readOnly": true }, "record_count": { "type": "string", "readOnly": true }, "server_count": { "type": "string", "readOnly": true }, "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "fqdn": { "type": "string", "maxLength": 255 }, "zone_type": { "$ref": "#/components/schemas/ZoneTypeEnum" }, "primary_ns": { "type": "string", "maxLength": 255 }, "admin_email": { "type": "string", "maxLength": 255 }, "serial": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "refresh": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "retry": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "expire": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "minimum_ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "default_ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "is_locked": { "type": "boolean" }, "description": { "type": "string", "maxLength": 256 }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "view": { "type": "integer" } }, "required": [ "created_at", "fqdn", "id", "record_count", "server_count", "updated_at", "view", "view_name" ] }, "PatchedDNSSECKeyRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "key_type": { "$ref": "#/components/schemas/DNSSECKeyKeyTypeEnum" }, "algorithm": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "algorithm_name": { "type": "string", "maxLength": 32 }, "key_tag": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "flags": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "protocol": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "public_key": { "type": "string", "minLength": 1 }, "private_key_pem": { "type": "string", "writeOnly": true, "minLength": 1 }, "state": { "$ref": "#/components/schemas/DNSSECKeyStateEnum" }, "activated_at": { "type": "string", "format": "date-time", "nullable": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "retired_at": { "type": "string", "format": "date-time", "nullable": true }, "zone": { "type": "integer" } } }, "PatchedIPAddressRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "address": { "type": "string", "minLength": 1 }, "hostname": { "type": "string", "maxLength": 255 }, "mac_address": { "type": "string", "maxLength": 17 }, "status": { "$ref": "#/components/schemas/IPAddressStatusEnum" }, "description": { "type": "string", "maxLength": 256 }, "dns_name": { "type": "string", "maxLength": 255 }, "interface": { "type": "string", "maxLength": 128 }, "last_seen": { "type": "string", "format": "date-time", "nullable": true }, "custom_fields": {}, "network": { "type": "integer" } } }, "DNSRecordRequest": { "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "minLength": 1, "description": "Relative to zone; '@' for apex", "maxLength": 255 }, "record_type": { "$ref": "#/components/schemas/DNSRecordRecordTypeEnum" }, "ttl": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "value": { "type": "string", "minLength": 1 }, "priority": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "weight": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "rdata_extra": {}, "comment": { "type": "string", "maxLength": 256 }, "disabled": { "type": "boolean" }, "auto_created": { "type": "boolean" }, "zone": { "type": "integer" } }, "required": [ "name", "record_type", "value", "zone" ] } } } }