{ "openapi": "3.0.3", "info": { "title": "Integrations API", "version": "1.0.0", "description": "Third-party integrations \u2014 Slack, Jira, ServiceNow, vSphere, SIEM, SCM, Rundeck, AWX, CrowdStrike, cloud, and cert platforms." }, "servers": [ { "url": "https://versus-demo.com" } ], "paths": { "/api/integrations/ai-providers/": { "get": { "operationId": "integrations_ai_providers_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": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIProvider" } } } }, "description": "" } }, "summary": "List ai providers" }, "post": { "operationId": "integrations_ai_providers_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProvider" } } }, "description": "" } }, "summary": "Create ai provider" } }, "/api/integrations/ai-providers/{id}/": { "get": { "operationId": "integrations_ai_providers_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 ai provider.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProvider" } } }, "description": "" } }, "summary": "Retrieve ai provider" }, "put": { "operationId": "integrations_ai_providers_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 ai provider.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProvider" } } }, "description": "" } }, "summary": "Update ai provider" }, "patch": { "operationId": "integrations_ai_providers_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 ai provider.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAIProviderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAIProviderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAIProviderRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProvider" } } }, "description": "" } }, "summary": "Update ai provider" }, "delete": { "operationId": "integrations_ai_providers_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 ai provider.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete ai provider" } }, "/api/integrations/ai-providers/{id}/set_default/": { "post": { "operationId": "integrations_ai_providers_set_default_create", "description": "Mark this provider as the active default; clears the flag on all others.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai provider.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProvider" } } }, "description": "" } }, "summary": "Set default: ai provider" } }, "/api/integrations/ai-providers/{id}/test/": { "post": { "operationId": "integrations_ai_providers_test_create", "description": "Send a minimal prompt to verify connectivity and auth.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ai provider.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AIProviderRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIProvider" } } }, "description": "" } }, "summary": "Test: ai provider" } }, "/api/integrations/auth-providers/": { "get": { "operationId": "integrations_auth_providers_list", "description": "Authentication / identity provider sources \u2014 AAA, NAC, IdP, directory, PAM.\nThe accounts held in these providers can be vaulted + rotated by Versus.", "parameters": [ { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "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" } }, { "in": "query", "name": "provider", "schema": { "type": "string", "enum": [ "aruba_clearpass", "beyondtrust", "cisco_acs", "cisco_duo", "cisco_ise", "cyberark", "delinea", "forescout", "forgerock", "freeradius", "hashicorp_vault", "microsoft_ad", "microsoft_entra", "microsoft_nps", "okta", "openldap", "other", "ping", "radius_generic", "rsa_securid", "tacacs_generic" ] }, "description": "* `cisco_ise` - Cisco Identity Services Engine (ISE)\n* `cisco_acs` - Cisco Secure ACS (TACACS+)\n* `aruba_clearpass` - Aruba ClearPass Policy Manager\n* `forescout` - Forescout eyeSight\n* `microsoft_nps` - Microsoft NPS (RADIUS)\n* `freeradius` - FreeRADIUS\n* `radius_generic` - RADIUS (generic)\n* `tacacs_generic` - TACACS+ (generic)\n* `microsoft_ad` - Microsoft Active Directory\n* `openldap` - OpenLDAP / LDAP\n* `microsoft_entra` - Microsoft Entra ID (Azure AD)\n* `okta` - Okta\n* `ping` - Ping Identity (PingFederate / PingOne)\n* `forgerock` - ForgeRock / PingAM\n* `cisco_duo` - Cisco Duo\n* `rsa_securid` - RSA SecurID\n* `cyberark` - CyberArk PAM\n* `beyondtrust` - BeyondTrust\n* `delinea` - Delinea (Thycotic) Secret Server\n* `hashicorp_vault` - HashiCorp Vault\n* `other` - Other" }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } }, { "in": "query", "name": "vault_managed", "schema": { "type": "boolean" } } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAuthProviderSourceList" } } }, "description": "" } }, "summary": "List auth providers" }, "post": { "operationId": "integrations_auth_providers_create", "description": "Authentication / identity provider sources \u2014 AAA, NAC, IdP, directory, PAM.\nThe accounts held in these providers can be vaulted + rotated by Versus.", "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSource" } } }, "description": "" } }, "summary": "Create auth provider" } }, "/api/integrations/auth-providers/{id}/": { "get": { "operationId": "integrations_auth_providers_retrieve", "description": "Authentication / identity provider sources \u2014 AAA, NAC, IdP, directory, PAM.\nThe accounts held in these providers can be vaulted + rotated by Versus.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this auth provider source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSource" } } }, "description": "" } }, "summary": "Retrieve auth provider" }, "put": { "operationId": "integrations_auth_providers_update", "description": "Authentication / identity provider sources \u2014 AAA, NAC, IdP, directory, PAM.\nThe accounts held in these providers can be vaulted + rotated by Versus.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this auth provider source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSource" } } }, "description": "" } }, "summary": "Update auth provider" }, "patch": { "operationId": "integrations_auth_providers_partial_update", "description": "Authentication / identity provider sources \u2014 AAA, NAC, IdP, directory, PAM.\nThe accounts held in these providers can be vaulted + rotated by Versus.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this auth provider source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAuthProviderSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAuthProviderSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAuthProviderSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSource" } } }, "description": "" } }, "summary": "Update auth provider" }, "delete": { "operationId": "integrations_auth_providers_destroy", "description": "Authentication / identity provider sources \u2014 AAA, NAC, IdP, directory, PAM.\nThe accounts held in these providers can be vaulted + rotated by Versus.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this auth provider source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete auth provider" } }, "/api/integrations/auth-providers/{id}/test_connection/": { "post": { "operationId": "integrations_auth_providers_test_connection_create", "description": "Reachability probe: confirm the provider endpoint is reachable. A full\nauthenticated check is provider-specific and runs against live credentials;\nthis validates network reachability + TLS to the configured endpoint.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this auth provider source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AuthProviderSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthProviderSource" } } }, "description": "" } }, "summary": "Test connection: auth provider" } }, "/api/integrations/awx-sources/": { "get": { "operationId": "integrations_awx_sources_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": "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAWXSourceList" } } }, "description": "" } }, "summary": "List awx sources" }, "post": { "operationId": "integrations_awx_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSource" } } }, "description": "" } }, "summary": "Create awx source" } }, "/api/integrations/awx-sources/{id}/": { "get": { "operationId": "integrations_awx_sources_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 awx source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSource" } } }, "description": "" } }, "summary": "Retrieve awx source" }, "put": { "operationId": "integrations_awx_sources_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 awx source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSource" } } }, "description": "" } }, "summary": "Update awx source" }, "patch": { "operationId": "integrations_awx_sources_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 awx source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAWXSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAWXSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAWXSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSource" } } }, "description": "" } }, "summary": "Update awx source" }, "delete": { "operationId": "integrations_awx_sources_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 awx source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete awx source" } }, "/api/integrations/awx-sources/{id}/test_connection/": { "post": { "operationId": "integrations_awx_sources_test_connection_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 awx source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AWXSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWXSource" } } }, "description": "" } }, "summary": "Test connection: awx source" } }, "/api/integrations/cert-platforms/": { "get": { "operationId": "integrations_cert_platforms_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": "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" } }, { "in": "query", "name": "platform_type", "schema": { "type": "string", "enum": [ "appviewx", "keyfactor", "venafi_cloud", "venafi_tpp" ] }, "description": "* `venafi_cloud` - Venafi TLS Protect Cloud (VaaS)\n* `venafi_tpp` - Venafi TLS Protect Data Center (TPP)\n* `keyfactor` - Keyfactor Command\n* `appviewx` - AppViewX CERT+" }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCertPlatformSourceList" } } }, "description": "" } }, "summary": "List cert platforms" }, "post": { "operationId": "integrations_cert_platforms_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Create cert platform" } }, "/api/integrations/cert-platforms/{id}/": { "get": { "operationId": "integrations_cert_platforms_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Retrieve cert platform" }, "put": { "operationId": "integrations_cert_platforms_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Update cert platform" }, "patch": { "operationId": "integrations_cert_platforms_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCertPlatformSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Update cert platform" }, "delete": { "operationId": "integrations_cert_platforms_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete cert platform" } }, "/api/integrations/cert-platforms/{id}/certificates/": { "get": { "operationId": "integrations_cert_platforms_certificates_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Certificates: cert platform" } }, "/api/integrations/cert-platforms/{id}/renew_certificate/": { "post": { "operationId": "integrations_cert_platforms_renew_certificate_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Renew certificate: cert platform" } }, "/api/integrations/cert-platforms/{id}/request_certificate/": { "post": { "operationId": "integrations_cert_platforms_request_certificate_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Request certificate: cert platform" } }, "/api/integrations/cert-platforms/{id}/revoke_certificate/": { "post": { "operationId": "integrations_cert_platforms_revoke_certificate_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Revoke certificate: cert platform" } }, "/api/integrations/cert-platforms/{id}/test_connection/": { "post": { "operationId": "integrations_cert_platforms_test_connection_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Test connection: cert platform" } }, "/api/integrations/cert-platforms/{id}/trigger_workflow/": { "post": { "operationId": "integrations_cert_platforms_trigger_workflow_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CertPlatformSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Trigger workflow: cert platform" } }, "/api/integrations/cert-platforms/{id}/workflows/": { "get": { "operationId": "integrations_cert_platforms_workflows_retrieve", "description": "List available workflows (AppViewX only).", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cert platform source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Workflows: cert platform" } }, "/api/integrations/cert-platforms/{id}/zones/": { "get": { "operationId": "integrations_cert_platforms_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 cert platform source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertPlatformSource" } } }, "description": "" } }, "summary": "Zones: cert platform" } }, "/api/integrations/cloud-accounts/": { "get": { "operationId": "integrations_cloud_accounts_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCloudAccountList" } } }, "description": "" } }, "summary": "List cloud accounts" }, "post": { "operationId": "integrations_cloud_accounts_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccount" } } }, "description": "" } }, "summary": "Create cloud account" } }, "/api/integrations/cloud-accounts/{id}/": { "get": { "operationId": "integrations_cloud_accounts_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 cloud account.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccount" } } }, "description": "" } }, "summary": "Retrieve cloud account" }, "put": { "operationId": "integrations_cloud_accounts_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 cloud account.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccount" } } }, "description": "" } }, "summary": "Update cloud account" }, "patch": { "operationId": "integrations_cloud_accounts_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 cloud account.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCloudAccountRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCloudAccountRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCloudAccountRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccount" } } }, "description": "" } }, "summary": "Update cloud account" }, "delete": { "operationId": "integrations_cloud_accounts_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 cloud account.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete cloud account" } }, "/api/integrations/cloud-accounts/{id}/test_connection/": { "post": { "operationId": "integrations_cloud_accounts_test_connection_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 cloud account.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CloudAccountRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudAccount" } } }, "description": "" } }, "summary": "Test connection: cloud account" } }, "/api/integrations/confluence-sources/": { "get": { "operationId": "integrations_confluence_sources_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": "deployment", "schema": { "type": "string", "enum": [ "cloud", "server" ] }, "description": "* `cloud` - Confluence Cloud (atlassian.net)\n* `server` - Confluence Server / Data Center" }, { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConfluenceSourceList" } } }, "description": "" } }, "summary": "List confluence sources" }, "post": { "operationId": "integrations_confluence_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSource" } } }, "description": "" } }, "summary": "Create confluence source" } }, "/api/integrations/confluence-sources/{id}/": { "get": { "operationId": "integrations_confluence_sources_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 confluence source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSource" } } }, "description": "" } }, "summary": "Retrieve confluence source" }, "put": { "operationId": "integrations_confluence_sources_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 confluence source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSource" } } }, "description": "" } }, "summary": "Update confluence source" }, "patch": { "operationId": "integrations_confluence_sources_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 confluence source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConfluenceSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConfluenceSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConfluenceSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSource" } } }, "description": "" } }, "summary": "Update confluence source" }, "delete": { "operationId": "integrations_confluence_sources_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 confluence source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete confluence source" } }, "/api/integrations/confluence-sources/{id}/test_connection/": { "post": { "operationId": "integrations_confluence_sources_test_connection_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 confluence source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConfluenceSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfluenceSource" } } }, "description": "" } }, "summary": "Test connection: confluence source" } }, "/api/integrations/controller-sources/": { "get": { "operationId": "integrations_controller_sources_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": "controller_type", "schema": { "type": "string", "enum": [ "apic", "avi", "nsx_mgr", "other", "panorama" ] }, "description": "* `avi` - VMware NSX ALB (Avi Controller)\n* `panorama` - Palo Alto Panorama\n* `nsx_mgr` - VMware NSX-T Manager\n* `apic` - Cisco ACI APIC\n* `other` - Other" }, { "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedControllerSourceList" } } }, "description": "" } }, "summary": "List controller sources" }, "post": { "operationId": "integrations_controller_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Create controller source" } }, "/api/integrations/controller-sources/{id}/": { "get": { "operationId": "integrations_controller_sources_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 controller source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Retrieve controller source" }, "put": { "operationId": "integrations_controller_sources_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 controller source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Update controller source" }, "patch": { "operationId": "integrations_controller_sources_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 controller source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedControllerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedControllerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedControllerSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Update controller source" }, "delete": { "operationId": "integrations_controller_sources_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 controller source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete controller source" } }, "/api/integrations/controller-sources/{id}/avi_clouds/": { "get": { "operationId": "integrations_controller_sources_avi_clouds_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 controller source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Avi clouds: controller source" } }, "/api/integrations/controller-sources/{id}/avi_se_groups/": { "get": { "operationId": "integrations_controller_sources_avi_se_groups_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 controller source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Avi se groups: controller source" } }, "/api/integrations/controller-sources/{id}/avi_tier1_lrs/": { "get": { "operationId": "integrations_controller_sources_avi_tier1_lrs_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 controller source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Avi tier1 lrs: controller source" } }, "/api/integrations/controller-sources/{id}/test_connection/": { "post": { "operationId": "integrations_controller_sources_test_connection_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 controller source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ControllerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControllerSource" } } }, "description": "" } }, "summary": "Test connection: controller source" } }, "/api/integrations/crowdstrike-sources/": { "get": { "operationId": "integrations_crowdstrike_sources_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": "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCrowdStrikeSourceList" } } }, "description": "" } }, "summary": "List crowdstrike sources" }, "post": { "operationId": "integrations_crowdstrike_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSource" } } }, "description": "" } }, "summary": "Create crowdstrike source" } }, "/api/integrations/crowdstrike-sources/{id}/": { "get": { "operationId": "integrations_crowdstrike_sources_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 crowd strike source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSource" } } }, "description": "" } }, "summary": "Retrieve crowdstrike source" }, "put": { "operationId": "integrations_crowdstrike_sources_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 crowd strike source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSource" } } }, "description": "" } }, "summary": "Update crowdstrike source" }, "patch": { "operationId": "integrations_crowdstrike_sources_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 crowd strike source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCrowdStrikeSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCrowdStrikeSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCrowdStrikeSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSource" } } }, "description": "" } }, "summary": "Update crowdstrike source" }, "delete": { "operationId": "integrations_crowdstrike_sources_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 crowd strike source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete crowdstrike source" } }, "/api/integrations/crowdstrike-sources/{id}/test_connection/": { "post": { "operationId": "integrations_crowdstrike_sources_test_connection_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 crowd strike source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrowdStrikeSource" } } }, "description": "" } }, "summary": "Test connection: crowdstrike source" } }, "/api/integrations/hsm-sources/": { "get": { "operationId": "integrations_hsm_sources_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" } }, { "in": "query", "name": "hsm_type", "schema": { "type": "string", "enum": [ "aws_cloudhsm", "azure_hsm", "entrust_nshield", "futurex", "google_cloud_hsm", "ibm_cloudhsm", "other", "securosys", "thales_luna", "thales_payshield", "utimaco", "yubihsm" ] }, "description": "* `thales_luna` - Thales Luna Network HSM\n* `thales_payshield` - Thales payShield 10K\n* `entrust_nshield` - Entrust nShield Connect\n* `utimaco` - Utimaco SecurityServer\n* `futurex` - Futurex KMES Series\n* `securosys` - Securosys Primus HSM\n* `yubihsm` - Yubico YubiHSM 2\n* `aws_cloudhsm` - AWS CloudHSM\n* `azure_hsm` - Azure Dedicated HSM / Managed HSM\n* `google_cloud_hsm` - Google Cloud HSM (Cloud KMS)\n* `ibm_cloudhsm` - IBM Cloud HSM\n* `other` - Other / Generic PKCS#11" }, { "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHSMSourceList" } } }, "description": "" } }, "summary": "List hsm sources" }, "post": { "operationId": "integrations_hsm_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSource" } } }, "description": "" } }, "summary": "Create hsm source" } }, "/api/integrations/hsm-sources/{id}/": { "get": { "operationId": "integrations_hsm_sources_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 hsm source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSource" } } }, "description": "" } }, "summary": "Retrieve hsm source" }, "put": { "operationId": "integrations_hsm_sources_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 hsm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSource" } } }, "description": "" } }, "summary": "Update hsm source" }, "patch": { "operationId": "integrations_hsm_sources_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 hsm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHSMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedHSMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedHSMSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSource" } } }, "description": "" } }, "summary": "Update hsm source" }, "delete": { "operationId": "integrations_hsm_sources_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 hsm source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete hsm source" } }, "/api/integrations/hsm-sources/{id}/test_connection/": { "post": { "operationId": "integrations_hsm_sources_test_connection_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 hsm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HSMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HSMSource" } } }, "description": "" } }, "summary": "Test connection: hsm source" } }, "/api/integrations/ipam-sources/": { "get": { "operationId": "integrations_ipam_sources_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedIPAMSourceList" } } }, "description": "" } }, "summary": "List ipam sources" }, "post": { "operationId": "integrations_ipam_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSource" } } }, "description": "" } }, "summary": "Create ipam source" } }, "/api/integrations/ipam-sources/{id}/": { "get": { "operationId": "integrations_ipam_sources_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 ipam source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSource" } } }, "description": "" } }, "summary": "Retrieve ipam source" }, "put": { "operationId": "integrations_ipam_sources_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 ipam source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSource" } } }, "description": "" } }, "summary": "Update ipam source" }, "patch": { "operationId": "integrations_ipam_sources_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 ipam source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedIPAMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedIPAMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedIPAMSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSource" } } }, "description": "" } }, "summary": "Update ipam source" }, "delete": { "operationId": "integrations_ipam_sources_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 ipam source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete ipam source" } }, "/api/integrations/ipam-sources/{id}/set_default/": { "post": { "operationId": "integrations_ipam_sources_set_default_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 ipam source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSource" } } }, "description": "" } }, "summary": "Set default: ipam source" } }, "/api/integrations/ipam-sources/{id}/test_connection/": { "post": { "operationId": "integrations_ipam_sources_test_connection_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 ipam source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IPAMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPAMSource" } } }, "description": "" } }, "summary": "Test connection: ipam source" } }, "/api/integrations/jira-sources/": { "get": { "operationId": "integrations_jira_sources_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": "deployment", "schema": { "type": "string", "enum": [ "cloud", "server" ] }, "description": "* `cloud` - Jira Cloud (atlassian.net)\n* `server` - Jira Server / Data Center" }, { "in": "query", "name": "enabled", "schema": { "type": "boolean" } }, { "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJiraSourceList" } } }, "description": "" } }, "summary": "List jira sources" }, "post": { "operationId": "integrations_jira_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSource" } } }, "description": "" } }, "summary": "Create jira source" } }, "/api/integrations/jira-sources/{id}/": { "get": { "operationId": "integrations_jira_sources_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 jira source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSource" } } }, "description": "" } }, "summary": "Retrieve jira source" }, "put": { "operationId": "integrations_jira_sources_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 jira source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSource" } } }, "description": "" } }, "summary": "Update jira source" }, "patch": { "operationId": "integrations_jira_sources_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 jira source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedJiraSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedJiraSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedJiraSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSource" } } }, "description": "" } }, "summary": "Update jira source" }, "delete": { "operationId": "integrations_jira_sources_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 jira source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete jira source" } }, "/api/integrations/jira-sources/{id}/test_connection/": { "post": { "operationId": "integrations_jira_sources_test_connection_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 jira source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JiraSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JiraSource" } } }, "description": "" } }, "summary": "Test connection: jira source" } }, "/api/integrations/network-overview/": { "get": { "operationId": "integrations_network_overview_retrieve", "description": "Aggregate view: devices + SIEM events + SCM commits for the command-centre page.", "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "List network overviews" } }, "/api/integrations/pager-sources/": { "get": { "operationId": "integrations_pager_sources_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": "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": "vendor", "schema": { "type": "string", "enum": [ "onpage", "opsgenie", "pagerduty", "victorops", "xmatters" ] }, "description": "* `pagerduty` - PagerDuty\n* `opsgenie` - Opsgenie (Atlassian)\n* `victorops` - Splunk On-Call / VictorOps\n* `xmatters` - xMatters\n* `onpage` - OnPage" } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPagerSourceList" } } }, "description": "" } }, "summary": "List pager sources" }, "post": { "operationId": "integrations_pager_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Create pager source" } }, "/api/integrations/pager-sources/{id}/": { "get": { "operationId": "integrations_pager_sources_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 pager source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Retrieve pager source" }, "put": { "operationId": "integrations_pager_sources_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 pager source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Update pager source" }, "patch": { "operationId": "integrations_pager_sources_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 pager source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPagerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPagerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPagerSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Update pager source" }, "delete": { "operationId": "integrations_pager_sources_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 pager source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete pager source" } }, "/api/integrations/pager-sources/{id}/resolve/": { "post": { "operationId": "integrations_pager_sources_resolve_create", "description": "Resolve an incident by its dedup_key.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pager source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Resolve: pager source" } }, "/api/integrations/pager-sources/{id}/test_connection/": { "post": { "operationId": "integrations_pager_sources_test_connection_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 pager source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Test connection: pager source" } }, "/api/integrations/pager-sources/{id}/trigger/": { "post": { "operationId": "integrations_pager_sources_trigger_create", "description": "Trigger a test/manual incident from the UI.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pager source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PagerSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PagerSource" } } }, "description": "" } }, "summary": "Trigger: pager source" } }, "/api/integrations/rapid7-sources/": { "get": { "operationId": "integrations_rapid7_sources_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": "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRapid7SourceList" } } }, "description": "" } }, "summary": "List rapid7 sources" }, "post": { "operationId": "integrations_rapid7_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7Source" } } }, "description": "" } }, "summary": "Create rapid7 source" } }, "/api/integrations/rapid7-sources/{id}/": { "get": { "operationId": "integrations_rapid7_sources_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 rapid7 source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7Source" } } }, "description": "" } }, "summary": "Retrieve rapid7 source" }, "put": { "operationId": "integrations_rapid7_sources_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 rapid7 source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7Source" } } }, "description": "" } }, "summary": "Update rapid7 source" }, "patch": { "operationId": "integrations_rapid7_sources_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 rapid7 source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRapid7SourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRapid7SourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRapid7SourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7Source" } } }, "description": "" } }, "summary": "Update rapid7 source" }, "delete": { "operationId": "integrations_rapid7_sources_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 rapid7 source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete rapid7 source" } }, "/api/integrations/rapid7-sources/{id}/test_connection/": { "post": { "operationId": "integrations_rapid7_sources_test_connection_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 rapid7 source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Rapid7SourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rapid7Source" } } }, "description": "" } }, "summary": "Test connection: rapid7 source" } }, "/api/integrations/rundeck-sources/": { "get": { "operationId": "integrations_rundeck_sources_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRundeckSourceList" } } }, "description": "" } }, "summary": "List rundeck sources" }, "post": { "operationId": "integrations_rundeck_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSource" } } }, "description": "" } }, "summary": "Create rundeck source" } }, "/api/integrations/rundeck-sources/{id}/": { "get": { "operationId": "integrations_rundeck_sources_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 rundeck source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSource" } } }, "description": "" } }, "summary": "Retrieve rundeck source" }, "put": { "operationId": "integrations_rundeck_sources_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 rundeck source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSource" } } }, "description": "" } }, "summary": "Update rundeck source" }, "patch": { "operationId": "integrations_rundeck_sources_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 rundeck source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRundeckSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRundeckSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRundeckSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSource" } } }, "description": "" } }, "summary": "Update rundeck source" }, "delete": { "operationId": "integrations_rundeck_sources_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 rundeck source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete rundeck source" } }, "/api/integrations/rundeck-sources/{id}/test_connection/": { "post": { "operationId": "integrations_rundeck_sources_test_connection_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 rundeck source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RundeckSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RundeckSource" } } }, "description": "" } }, "summary": "Test connection: rundeck source" } }, "/api/integrations/scm-commits/": { "get": { "operationId": "integrations_scm_commits_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSCMCommitList" } } }, "description": "" } }, "summary": "List scm commits" } }, "/api/integrations/scm-commits/{id}/": { "get": { "operationId": "integrations_scm_commits_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 scm commit.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMCommit" } } }, "description": "" } }, "summary": "Retrieve scm commit" } }, "/api/integrations/scm-sources/": { "get": { "operationId": "integrations_scm_sources_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSCMSourceList" } } }, "description": "" } }, "summary": "List scm sources" }, "post": { "operationId": "integrations_scm_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Create scm source" } }, "/api/integrations/scm-sources/{id}/": { "get": { "operationId": "integrations_scm_sources_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 scm source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Retrieve scm source" }, "put": { "operationId": "integrations_scm_sources_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 scm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Update scm source" }, "patch": { "operationId": "integrations_scm_sources_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 scm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSCMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSCMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSCMSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Update scm source" }, "delete": { "operationId": "integrations_scm_sources_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 scm source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete scm source" } }, "/api/integrations/scm-sources/{id}/list_repos/": { "get": { "operationId": "integrations_scm_sources_list_repos_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 scm source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "List repos: scm source" } }, "/api/integrations/scm-sources/{id}/recent_commits/": { "get": { "operationId": "integrations_scm_sources_recent_commits_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 scm source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Recent commits: scm source" } }, "/api/integrations/scm-sources/{id}/sync/": { "post": { "operationId": "integrations_scm_sources_sync_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 scm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Sync: scm source" } }, "/api/integrations/scm-sources/{id}/sync_async/": { "post": { "operationId": "integrations_scm_sources_sync_async_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 scm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Sync async: scm source" } }, "/api/integrations/scm-sources/{id}/test_connection/": { "post": { "operationId": "integrations_scm_sources_test_connection_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 scm source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SCMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SCMSource" } } }, "description": "" } }, "summary": "Test connection: scm source" } }, "/api/integrations/siem-events/": { "get": { "operationId": "integrations_siem_events_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSIEMEventList" } } }, "description": "" } }, "summary": "List siem events" } }, "/api/integrations/siem-events/{id}/": { "get": { "operationId": "integrations_siem_events_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 siem event.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMEvent" } } }, "description": "" } }, "summary": "Retrieve siem event" } }, "/api/integrations/siem-events/{id}/set_status/": { "patch": { "operationId": "integrations_siem_events_set_status_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 siem event.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSIEMEventRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSIEMEventRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSIEMEventRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMEvent" } } }, "description": "" } }, "summary": "Set status: siem event" } }, "/api/integrations/siem-sources/": { "get": { "operationId": "integrations_siem_sources_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSIEMSourceList" } } }, "description": "" } }, "summary": "List siem sources" }, "post": { "operationId": "integrations_siem_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Create siem source" } }, "/api/integrations/siem-sources/{id}/": { "get": { "operationId": "integrations_siem_sources_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 siem source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Retrieve siem source" }, "put": { "operationId": "integrations_siem_sources_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 siem source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Update siem source" }, "patch": { "operationId": "integrations_siem_sources_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 siem source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSIEMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSIEMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSIEMSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Update siem source" }, "delete": { "operationId": "integrations_siem_sources_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 siem source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete siem source" } }, "/api/integrations/siem-sources/{id}/sync_events/": { "post": { "operationId": "integrations_siem_sources_sync_events_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 siem source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Sync events: siem source" } }, "/api/integrations/siem-sources/{id}/sync_events_async/": { "post": { "operationId": "integrations_siem_sources_sync_events_async_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 siem source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Sync events async: siem source" } }, "/api/integrations/siem-sources/{id}/test_connection/": { "post": { "operationId": "integrations_siem_sources_test_connection_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 siem source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SIEMSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "Test connection: siem source" } }, "/api/integrations/siem-sources/summary/": { "get": { "operationId": "integrations_siem_sources_summary_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).", "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIEMSource" } } }, "description": "" } }, "summary": "List summarys" } }, "/api/integrations/slack-sources/": { "get": { "operationId": "integrations_slack_sources_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": "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSlackSourceList" } } }, "description": "" } }, "summary": "List slack sources" }, "post": { "operationId": "integrations_slack_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSource" } } }, "description": "" } }, "summary": "Create slack source" } }, "/api/integrations/slack-sources/{id}/": { "get": { "operationId": "integrations_slack_sources_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 slack source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSource" } } }, "description": "" } }, "summary": "Retrieve slack source" }, "put": { "operationId": "integrations_slack_sources_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 slack source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSource" } } }, "description": "" } }, "summary": "Update slack source" }, "patch": { "operationId": "integrations_slack_sources_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 slack source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedSlackSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedSlackSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedSlackSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSource" } } }, "description": "" } }, "summary": "Update slack source" }, "delete": { "operationId": "integrations_slack_sources_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 slack source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete slack source" } }, "/api/integrations/slack-sources/{id}/send_test_message/": { "post": { "operationId": "integrations_slack_sources_send_test_message_create", "description": "Send a test message to verify the integration.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this slack source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSource" } } }, "description": "" } }, "summary": "Send test message: slack source" } }, "/api/integrations/slack-sources/{id}/test_connection/": { "post": { "operationId": "integrations_slack_sources_test_connection_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 slack source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SlackSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackSource" } } }, "description": "" } }, "summary": "Test connection: slack source" } }, "/api/integrations/thousandeyes-sources/": { "get": { "operationId": "integrations_thousandeyes_sources_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": "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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedThousandEyesSourceList" } } }, "description": "" } }, "summary": "List thousandeyes sources" }, "post": { "operationId": "integrations_thousandeyes_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Create thousandeyes source" } }, "/api/integrations/thousandeyes-sources/{id}/": { "get": { "operationId": "integrations_thousandeyes_sources_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 thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Retrieve thousandeyes source" }, "put": { "operationId": "integrations_thousandeyes_sources_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 thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Update thousandeyes source" }, "patch": { "operationId": "integrations_thousandeyes_sources_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 thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedThousandEyesSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedThousandEyesSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedThousandEyesSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Update thousandeyes source" }, "delete": { "operationId": "integrations_thousandeyes_sources_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 thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete thousandeyes source" } }, "/api/integrations/thousandeyes-sources/{id}/agents/": { "get": { "operationId": "integrations_thousandeyes_sources_agents_retrieve", "description": "Return ThousandEyes agent list.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Agents: thousandeyes source" } }, "/api/integrations/thousandeyes-sources/{id}/alerts/": { "get": { "operationId": "integrations_thousandeyes_sources_alerts_retrieve", "description": "Return active ThousandEyes alerts.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Alerts: thousandeyes source" } }, "/api/integrations/thousandeyes-sources/{id}/test_connection/": { "post": { "operationId": "integrations_thousandeyes_sources_test_connection_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 thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ThousandEyesSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Test connection: thousandeyes source" } }, "/api/integrations/thousandeyes-sources/{id}/tests/": { "get": { "operationId": "integrations_thousandeyes_sources_tests_retrieve", "description": "Return the list of ThousandEyes tests for this account.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this thousand eyes source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThousandEyesSource" } } }, "description": "" } }, "summary": "Tests: thousandeyes source" } }, "/api/integrations/vsphere-sources/": { "get": { "operationId": "integrations_vsphere_sources_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedVSphereSourceList" } } }, "description": "" } }, "summary": "List vsphere sources" }, "post": { "operationId": "integrations_vsphere_sources_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Create vsphere source" } }, "/api/integrations/vsphere-sources/{id}/": { "get": { "operationId": "integrations_vsphere_sources_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 v sphere source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Retrieve vsphere source" }, "put": { "operationId": "integrations_vsphere_sources_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 v sphere source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Update vsphere source" }, "patch": { "operationId": "integrations_vsphere_sources_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 v sphere source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedVSphereSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedVSphereSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedVSphereSourceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Update vsphere source" }, "delete": { "operationId": "integrations_vsphere_sources_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 v sphere source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete vsphere source" } }, "/api/integrations/vsphere-sources/{id}/inventory/": { "get": { "operationId": "integrations_vsphere_sources_inventory_retrieve", "description": "Fetch live inventory (VMs, clusters, datastores, etc.) for VM profile creation.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this v sphere source.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Inventory: vsphere source" } }, "/api/integrations/vsphere-sources/{id}/sync/": { "post": { "operationId": "integrations_vsphere_sources_sync_create", "description": "Pull VM + host inventory and cache counts in metadata.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this v sphere source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Sync: vsphere source" } }, "/api/integrations/vsphere-sources/{id}/test_connection/": { "post": { "operationId": "integrations_vsphere_sources_test_connection_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 v sphere source.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VSphereSourceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereSource" } } }, "description": "" } }, "summary": "Test connection: vsphere source" } }, "/api/integrations/vsphere-vm-profiles/": { "get": { "operationId": "integrations_vsphere_vm_profiles_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": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedVSphereVMProfileList" } } }, "description": "" } }, "summary": "List vsphere vm profiles" }, "post": { "operationId": "integrations_vsphere_vm_profiles_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": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereVMProfileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VSphereVMProfileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VSphereVMProfileRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereVMProfile" } } }, "description": "" } }, "summary": "Create vsphere vm profile" } }, "/api/integrations/vsphere-vm-profiles/{id}/": { "get": { "operationId": "integrations_vsphere_vm_profiles_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 v sphere vm profile.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereVMProfile" } } }, "description": "" } }, "summary": "Retrieve vsphere vm profile" }, "put": { "operationId": "integrations_vsphere_vm_profiles_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 v sphere vm profile.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereVMProfileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VSphereVMProfileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/VSphereVMProfileRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereVMProfile" } } }, "description": "" } }, "summary": "Update vsphere vm profile" }, "patch": { "operationId": "integrations_vsphere_vm_profiles_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 v sphere vm profile.", "required": true } ], "tags": [ "integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedVSphereVMProfileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedVSphereVMProfileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedVSphereVMProfileRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VSphereVMProfile" } } }, "description": "" } }, "summary": "Update vsphere vm profile" }, "delete": { "operationId": "integrations_vsphere_vm_profiles_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 v sphere vm profile.", "required": true } ], "tags": [ "integrations" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete vsphere vm profile" } }, "/api/snow-instances/": { "get": { "operationId": "snow_instances_list", "parameters": [ { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "search", "required": false, "in": "query", "description": "A search term.", "schema": { "type": "string" } } ], "tags": [ "snow-instances" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceNowInstance" } } } }, "description": "" } }, "summary": "List snow instances" }, "post": { "operationId": "snow_instances_create", "tags": [ "snow-instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Create snow instance" } }, "/api/snow-instances/{id}/": { "get": { "operationId": "snow_instances_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Retrieve snow instance" }, "put": { "operationId": "snow_instances_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Update snow instance" }, "patch": { "operationId": "snow_instances_partial_update", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedServiceNowInstanceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedServiceNowInstanceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedServiceNowInstanceRequest" } } } }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Update snow instance" }, "delete": { "operationId": "snow_instances_destroy", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "security": [ { "jwtAuth": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete snow instance" } }, "/api/snow-instances/{id}/change_templates/": { "get": { "operationId": "snow_instances_change_templates_retrieve", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Change templates: snow instance" } }, "/api/snow-instances/{id}/set_default/": { "post": { "operationId": "snow_instances_set_default_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Set default: snow instance" } }, "/api/snow-instances/{id}/start_cmdb_import/": { "post": { "operationId": "snow_instances_start_cmdb_import_create", "description": "Kick off a background pull of server CIs from this instance's CMDB.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Start cmdb import: snow instance" } }, "/api/snow-instances/{id}/test_connection/": { "post": { "operationId": "snow_instances_test_connection_create", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this service now instance.", "required": true } ], "tags": [ "snow-instances" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ServiceNowInstanceRequest" } } }, "required": true }, "security": [ { "jwtAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNowInstance" } } }, "description": "" } }, "summary": "Test connection: snow instance" } } }, "components": { "schemas": { "PatchedAWXSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://tower.corp.com", "maxLength": 500 }, "api_token": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "DefaultSeverityEnum": { "enum": [ "critical", "error", "warning", "info" ], "type": "string", "description": "* `critical` - Critical\n* `error` - Error\n* `warning` - Warning\n* `info` - Info" }, "PaginatedRapid7SourceList": { "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/Rapid7Source" } } } }, "PaginatedAWXSourceList": { "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/AWXSource" } } } }, "PatchedVSphereSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "vCenter base URL, e.g. https://vcenter.corp.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "datacenter": { "type": "string", "description": "Filter by datacenter name (leave blank for all)", "maxLength": 200 }, "extra_config": {}, "enabled": { "type": "boolean" } } }, "RundeckSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "description": "Base URL, e.g. https://rundeck.corp.com", "maxLength": 500 }, "api_version": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Rundeck API version to use (14+ for modern features)" }, "default_project": { "type": "string", "description": "Optional default project name for job lookups", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: server version, node count, active executions" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "url" ] }, "PatchedSIEMEventRequest": { "type": "object", "properties": { "source": { "type": "integer" }, "severity": { "$ref": "#/components/schemas/Severity0d8Enum" }, "title": { "type": "string", "minLength": 1, "maxLength": 500 }, "category": { "type": "string", "maxLength": 100 }, "src_ip": { "type": "string", "nullable": true, "minLength": 1 }, "dst_ip": { "type": "string", "nullable": true, "minLength": 1 }, "hostname": { "type": "string", "maxLength": 255 }, "device": { "type": "integer", "nullable": true }, "event_time": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/SIEMEventStatusEnum" } } }, "CertPlatformSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "platform_type": { "$ref": "#/components/schemas/PlatformTypeEnum" }, "platform_type_label": { "type": "string", "readOnly": true }, "base_url": { "type": "string", "description": "Venafi Cloud: https://api.venafi.cloud | TPP: https://tpp.corp.com | Keyfactor: https://kf.corp.com/KeyfactorAPI | AppViewX: https://avx.corp.com", "maxLength": 500 }, "username": { "type": "string", "description": "Venafi TPP / Keyfactor / AppViewX username", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: zones/templates/CAs, cert count, workflow count" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "base_url", "created_at", "id", "last_tested", "metadata", "name", "platform_type_label", "status", "status_msg", "updated_at" ] }, "Rapid7SourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "InsightVM console URL, e.g. https://hostname:3780", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "description": "InsightVM username", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name", "username" ] }, "PatchedJiraSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "deployment": { "$ref": "#/components/schemas/JiraSourceDeploymentEnum" }, "url": { "type": "string", "minLength": 1, "description": "Cloud: https://yourorg.atlassian.net | Server: https://jira.corp.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "description": "Your Atlassian account email (Cloud) or local username (Server)", "maxLength": 200 }, "api_token": { "type": "string", "writeOnly": true }, "default_project": { "type": "string", "description": "Project key used when no project is specified, e.g. NET or OPS", "maxLength": 50 }, "default_issue_type": { "type": "string", "minLength": 1, "description": "Default issue type: Task, Bug, Story, etc.", "maxLength": 100 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "AWXSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "description": "Base URL, e.g. https://tower.corp.com", "maxLength": 500 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: AWX version, template count, etc." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "url" ] }, "JiraSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "deployment": { "$ref": "#/components/schemas/JiraSourceDeploymentEnum" }, "url": { "type": "string", "description": "Cloud: https://yourorg.atlassian.net | Server: https://jira.corp.com", "maxLength": 500 }, "username": { "type": "string", "description": "Your Atlassian account email (Cloud) or local username (Server)", "maxLength": 200 }, "default_project": { "type": "string", "description": "Project key used when no project is specified, e.g. NET or OPS", "maxLength": 50 }, "default_issue_type": { "type": "string", "description": "Default issue type: Task, Bug, Story, etc.", "maxLength": 100 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "url", "username" ] }, "PaginatedSlackSourceList": { "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/SlackSource" } } } }, "AIProviderRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "provider_type": { "$ref": "#/components/schemas/AIProviderProviderTypeEnum" }, "base_url": { "type": "string", "description": "Required for openai_compatible \u2014 e.g. http://localhost:11434/v1", "maxLength": 500 }, "model": { "type": "string", "description": "Leave blank to use provider default", "maxLength": 200 }, "api_key": { "type": "string", "writeOnly": true }, "is_default": { "type": "boolean", "description": "Only one provider is used at a time" }, "enabled": { "type": "boolean" } }, "required": [ "name" ] }, "SCMCommit": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "source": { "type": "integer" }, "source_name": { "type": "string", "readOnly": true }, "repo": { "type": "string", "maxLength": 300 }, "sha": { "type": "string", "maxLength": 64 }, "author": { "type": "string", "maxLength": 200 }, "message": { "type": "string", "maxLength": 1000 }, "url": { "type": "string", "maxLength": 1000 }, "committed_at": { "type": "string", "format": "date-time" }, "files_changed": {}, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "committed_at", "created_at", "id", "repo", "sha", "source", "source_name" ] }, "PaginatedVSphereVMProfileList": { "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/VSphereVMProfile" } } } }, "ThousandEyesSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "oauth_token": { "type": "string", "writeOnly": true }, "account_group_id": { "type": "string", "description": "Account Group ID (aid) to scope requests. Leave blank to use the default group.", "maxLength": 100 }, "base_url": { "type": "string", "minLength": 1, "description": "API base URL. Change only for sovereign cloud deployments.", "maxLength": 500 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name" ] }, "VSphereVMProfile": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "vsphere_source": { "type": "integer" }, "source_name": { "type": "string", "readOnly": true }, "name": { "type": "string", "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 }, "template_name": { "type": "string", "description": "Template VM display name in vCenter", "maxLength": 200 }, "datacenter": { "type": "string", "maxLength": 200 }, "cluster": { "type": "string", "maxLength": 200 }, "datastore": { "type": "string", "maxLength": 200 }, "folder": { "type": "string", "maxLength": 200 }, "network": { "type": "string", "maxLength": 200 }, "resource_pool": { "type": "string", "maxLength": 200 }, "cpu_count": { "type": "integer", "maximum": 32767, "minimum": 0 }, "memory_mb": { "type": "integer", "maximum": 2147483647, "minimum": 0, "description": "Memory in MiB" }, "disk_gb": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true, "description": "Disk size in GB (blank = keep template size)" }, "customization_spec": { "type": "string", "maxLength": 200 }, "os_type": { "oneOf": [ { "$ref": "#/components/schemas/OsTypeEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "notes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "cluster", "created_at", "datastore", "id", "name", "source_name", "template_name", "updated_at", "vsphere_source" ] }, "SIEMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "source_type": { "$ref": "#/components/schemas/SIEMSourceSourceTypeEnum" }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://splunk.corp.com:8089", "maxLength": 500 }, "token": { "type": "string", "writeOnly": true }, "username": { "type": "string", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Source-specific options (index, workspace_id, etc.)" }, "enabled": { "type": "boolean" } }, "required": [ "name", "url" ] }, "PatchedCrowdStrikeSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "base_url": { "type": "string", "minLength": 1, "description": "CrowdStrike cloud base URL \u2014 US-1, US-2, EU-1, or US-GOV-1", "maxLength": 500 }, "client_id": { "type": "string", "minLength": 1, "description": "OAuth2 Client ID from Falcon API Clients & Keys", "maxLength": 200 }, "client_secret": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "PaginatedCloudAccountList": { "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/CloudAccount" } } } }, "SIEMSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "source_type": { "$ref": "#/components/schemas/SIEMSourceSourceTypeEnum" }, "url": { "type": "string", "description": "Base URL, e.g. https://splunk.corp.com:8089", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Source-specific options (index, workspace_id, etc.)" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status54bEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_synced": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "event_count": { "type": "string", "readOnly": true }, "critical_count": { "type": "string", "readOnly": true } }, "required": [ "created_at", "critical_count", "event_count", "id", "last_synced", "name", "status", "status_msg", "updated_at", "url" ] }, "AIProviderProviderTypeEnum": { "enum": [ "anthropic", "openai_compatible" ], "type": "string", "description": "* `anthropic` - Anthropic Claude\n* `openai_compatible` - OpenAI-compatible (Azure OpenAI, Ollama, vLLM, LM Studio\u2026)" }, "Severity0d8Enum": { "enum": [ "critical", "high", "medium", "low", "info" ], "type": "string", "description": "* `critical` - Critical\n* `high` - High\n* `medium` - Medium\n* `low` - Low\n* `info` - Info" }, "PatchedPagerSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "vendor": { "$ref": "#/components/schemas/PagerSourceVendorEnum" }, "routing_key": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "url": { "type": "string", "description": "Override base URL (e.g. https://api.eu.opsgenie.com or xMatters instance URL)", "maxLength": 500 }, "default_severity": { "$ref": "#/components/schemas/DefaultSeverityEnum" }, "enabled": { "type": "boolean" } } }, "PatchedCertPlatformSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "platform_type": { "$ref": "#/components/schemas/PlatformTypeEnum" }, "base_url": { "type": "string", "minLength": 1, "description": "Venafi Cloud: https://api.venafi.cloud | TPP: https://tpp.corp.com | Keyfactor: https://kf.corp.com/KeyfactorAPI | AppViewX: https://avx.corp.com", "maxLength": 500 }, "api_key": { "type": "string", "writeOnly": true }, "username": { "type": "string", "description": "Venafi TPP / Keyfactor / AppViewX username", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "Status54bEnum": { "enum": [ "unchecked", "ok", "error" ], "type": "string", "description": "* `unchecked` - Not checked\n* `ok` - Connected\n* `error` - Connection error" }, "PatchedConfluenceSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "deployment": { "$ref": "#/components/schemas/ConfluenceSourceDeploymentEnum" }, "url": { "type": "string", "minLength": 1, "description": "Cloud: https://yourorg.atlassian.net | Server: https://confluence.corp.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "description": "Your Atlassian account email (Cloud) or local username (Server)", "maxLength": 200 }, "api_token": { "type": "string", "writeOnly": true }, "default_space": { "type": "string", "description": "Space key used when no space is specified, e.g. NET or NETOPS", "maxLength": 100 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "AWXSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://tower.corp.com", "maxLength": 500 }, "api_token": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name", "url" ] }, "SIEMEventStatusEnum": { "enum": [ "new", "reviewing", "suppressed", "resolved" ], "type": "string", "description": "* `new` - New\n* `reviewing` - Reviewing\n* `suppressed` - Suppressed\n* `resolved` - Resolved" }, "CrowdStrikeSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "base_url": { "type": "string", "minLength": 1, "description": "CrowdStrike cloud base URL \u2014 US-1, US-2, EU-1, or US-GOV-1", "maxLength": 500 }, "client_id": { "type": "string", "minLength": 1, "description": "OAuth2 Client ID from Falcon API Clients & Keys", "maxLength": 200 }, "client_secret": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "client_id", "name" ] }, "PatchedHSMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hsm_type": { "$ref": "#/components/schemas/HsmTypeEnum" }, "host": { "type": "string", "minLength": 1, "description": "Hostname or IP of HSM / management endpoint", "maxLength": 500 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Network port (Luna: 1792, nShield: 9004, REST: 443)" }, "partition": { "type": "string", "description": "Partition name, slot label, or key group (vendor-specific)", "maxLength": 200 }, "username": { "type": "string", "description": "Admin / CO username", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "pin": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Vendor-specific options (e.g. client cert path, cluster ID, region)" }, "enabled": { "type": "boolean" } } }, "Status0aeEnum": { "enum": [ "unchecked", "ok", "error" ], "type": "string", "description": "* `unchecked` - Not tested\n* `ok` - Connected\n* `error` - Connection error" }, "IPAMSourceSourceTypeEnum": { "enum": [ "infoblox", "bluecat", "efficientip", "phpipam", "netbox", "other" ], "type": "string", "description": "* `infoblox` - Infoblox NIOS / Cloud\n* `bluecat` - BlueCat Address Manager\n* `efficientip` - EfficientIP SOLIDserver\n* `phpipam` - phpIPAM\n* `netbox` - NetBox\n* `other` - Other / Generic" }, "CrowdStrikeSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "base_url": { "type": "string", "description": "CrowdStrike cloud base URL \u2014 US-1, US-2, EU-1, or US-GOV-1", "maxLength": 500 }, "client_id": { "type": "string", "description": "OAuth2 Client ID from Falcon API Clients & Keys", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: sensor count, subscription info, etc." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "client_id", "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at" ] }, "PaginatedPagerSourceList": { "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/PagerSource" } } } }, "IPAMSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "source_type": { "$ref": "#/components/schemas/IPAMSourceSourceTypeEnum" }, "url": { "type": "string", "description": "Base URL, e.g. https://grid-master.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Extra options: {\"wapi_version\": \"2.11\"} for Infoblox, {\"app_name\": \"versus\"} for phpIPAM" }, "enabled": { "type": "boolean" }, "is_default": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status54bEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_synced": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_synced", "name", "status", "status_msg", "updated_at", "url" ] }, "SIEMEvent": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "source": { "type": "integer" }, "source_name": { "type": "string", "readOnly": true }, "source_type": { "type": "string", "readOnly": true }, "severity": { "$ref": "#/components/schemas/Severity0d8Enum" }, "title": { "type": "string", "maxLength": 500 }, "category": { "type": "string", "maxLength": 100 }, "src_ip": { "type": "string", "nullable": true }, "dst_ip": { "type": "string", "nullable": true }, "hostname": { "type": "string", "maxLength": 255 }, "device": { "type": "integer", "nullable": true }, "device_name": { "type": "string", "readOnly": true }, "device_id": { "type": "string", "readOnly": true }, "event_time": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/SIEMEventStatusEnum" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "device_id", "device_name", "event_time", "id", "source", "source_name", "source_type", "title" ] }, "PatchedSIEMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "source_type": { "$ref": "#/components/schemas/SIEMSourceSourceTypeEnum" }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://splunk.corp.com:8089", "maxLength": 500 }, "token": { "type": "string", "writeOnly": true }, "username": { "type": "string", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Source-specific options (index, workspace_id, etc.)" }, "enabled": { "type": "boolean" } } }, "VSphereSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "description": "vCenter base URL, e.g. https://vcenter.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "datacenter": { "type": "string", "description": "Filter by datacenter name (leave blank for all)", "maxLength": 200 }, "extra_config": {}, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_synced": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: version, vm_count, host_count, datacenters" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_synced", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "url", "username" ] }, "PatchedIPAMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "source_type": { "$ref": "#/components/schemas/IPAMSourceSourceTypeEnum" }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://grid-master.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "token": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Extra options: {\"wapi_version\": \"2.11\"} for Infoblox, {\"app_name\": \"versus\"} for phpIPAM" }, "enabled": { "type": "boolean" }, "is_default": { "type": "boolean" } } }, "Rapid7Source": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "url": { "type": "string", "description": "InsightVM console URL, e.g. https://hostname:3780", "maxLength": 500 }, "username": { "type": "string", "description": "InsightVM username", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: API version, site count, asset count, etc." }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "username" ] }, "PaginatedControllerSourceList": { "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/ControllerSource" } } } }, "PagerSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "vendor": { "$ref": "#/components/schemas/PagerSourceVendorEnum" }, "url": { "type": "string", "description": "Override base URL (e.g. https://api.eu.opsgenie.com or xMatters instance URL)", "maxLength": 500 }, "default_severity": { "$ref": "#/components/schemas/DefaultSeverityEnum" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at" ] }, "PatchedSCMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "scm_type": { "$ref": "#/components/schemas/ScmTypeEnum" }, "url": { "type": "string", "description": "Leave blank for github.com / gitlab.com. Required for self-hosted.", "maxLength": 500 }, "token": { "type": "string", "writeOnly": true }, "username": { "type": "string", "description": "GitHub username or org (used to list repos)", "maxLength": 200 }, "default_branch": { "type": "string", "minLength": 1, "maxLength": 100 }, "watch_repos": { "description": "List of owner/repo slugs to watch, e.g. [\"acme/network-configs\"]" }, "extra_config": {}, "enabled": { "type": "boolean" } } }, "PaginatedConfluenceSourceList": { "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/ConfluenceSource" } } } }, "IPAMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "source_type": { "$ref": "#/components/schemas/IPAMSourceSourceTypeEnum" }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://grid-master.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "token": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Extra options: {\"wapi_version\": \"2.11\"} for Infoblox, {\"app_name\": \"versus\"} for phpIPAM" }, "enabled": { "type": "boolean" }, "is_default": { "type": "boolean" } }, "required": [ "name", "url" ] }, "CloudAccount": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 200 }, "provider": { "$ref": "#/components/schemas/CloudAccountProviderEnum" }, "description": { "type": "string", "maxLength": 500 }, "enabled": { "type": "boolean" }, "account_id": { "type": "string", "description": "AWS Account ID / Azure Subscription ID / GCP Project ID", "maxLength": 200 }, "regions": { "description": "Regions to scope sync/monitoring (empty = all)" }, "aws_access_key": { "type": "string", "description": "IAM Access Key ID", "maxLength": 500 }, "aws_role_arn": { "type": "string", "description": "Optional IAM Role ARN to assume (cross-account)", "maxLength": 500 }, "azure_tenant_id": { "type": "string", "maxLength": 200 }, "azure_client_id": { "type": "string", "description": "App registration (Service Principal) Client ID", "maxLength": 200 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: caller identity, subscription name, project info" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "provider", "status", "status_msg", "updated_at" ] }, "PatchedAuthProviderSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "provider": { "$ref": "#/components/schemas/AuthProviderSourceProviderEnum" }, "base_url": { "type": "string", "description": "API base URL. ISE: https://ise.corp:9060 (ERS) \u00b7 Okta: https://org.okta.com \u00b7 ClearPass: https://cppm.corp \u00b7 Entra: https://graph.microsoft.com", "maxLength": 500 }, "host": { "type": "string", "description": "Host for RADIUS/TACACS+/LDAP providers (when there is no HTTPS API)", "maxLength": 255 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "e.g. 1812 RADIUS \u00b7 49 TACACS+ \u00b7 636 LDAPS \u00b7 9060 ISE ERS" }, "username": { "type": "string", "description": "API/admin user or bind DN (ISE ERS admin, LDAP bind DN, ...)", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "shared_secret": { "type": "string", "writeOnly": true }, "vault_managed": { "type": "boolean", "description": "Vault and rotate the accounts sourced from this provider" }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "PaginatedSIEMSourceList": { "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/SIEMSource" } } } }, "PaginatedSIEMEventList": { "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/SIEMEvent" } } } }, "AuthProviderSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "provider": { "$ref": "#/components/schemas/AuthProviderSourceProviderEnum" }, "base_url": { "type": "string", "description": "API base URL. ISE: https://ise.corp:9060 (ERS) \u00b7 Okta: https://org.okta.com \u00b7 ClearPass: https://cppm.corp \u00b7 Entra: https://graph.microsoft.com", "maxLength": 500 }, "host": { "type": "string", "description": "Host for RADIUS/TACACS+/LDAP providers (when there is no HTTPS API)", "maxLength": 255 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "e.g. 1812 RADIUS \u00b7 49 TACACS+ \u00b7 636 LDAPS \u00b7 9060 ISE ERS" }, "username": { "type": "string", "description": "API/admin user or bind DN (ISE ERS admin, LDAP bind DN, ...)", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "shared_secret": { "type": "string", "writeOnly": true }, "vault_managed": { "type": "boolean", "description": "Vault and rotate the accounts sourced from this provider" }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name" ] }, "SCMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "scm_type": { "$ref": "#/components/schemas/ScmTypeEnum" }, "url": { "type": "string", "description": "Leave blank for github.com / gitlab.com. Required for self-hosted.", "maxLength": 500 }, "token": { "type": "string", "writeOnly": true }, "username": { "type": "string", "description": "GitHub username or org (used to list repos)", "maxLength": 200 }, "default_branch": { "type": "string", "minLength": 1, "maxLength": 100 }, "watch_repos": { "description": "List of owner/repo slugs to watch, e.g. [\"acme/network-configs\"]" }, "extra_config": {}, "enabled": { "type": "boolean" } }, "required": [ "name" ] }, "PaginatedAuthProviderSourceList": { "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/AuthProviderSource" } } } }, "PatchedRapid7SourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "InsightVM console URL, e.g. https://hostname:3780", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "description": "InsightVM username", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "ControllerSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "controller_type": { "$ref": "#/components/schemas/ControllerTypeEnum" }, "url": { "type": "string", "description": "Base URL, e.g. https://avi-ctrl.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "tenant": { "type": "string", "description": "Avi: tenant name (default \"admin\"). APIC: leave blank.", "maxLength": 200 }, "extra_config": {}, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status54bEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "controller_type", "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "url" ] }, "RundeckSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://rundeck.corp.com", "maxLength": 500 }, "api_token": { "type": "string", "writeOnly": true }, "api_version": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Rundeck API version to use (14+ for modern features)" }, "default_project": { "type": "string", "description": "Optional default project name for job lookups", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name", "url" ] }, "PlatformTypeEnum": { "enum": [ "venafi_cloud", "venafi_tpp", "keyfactor", "appviewx" ], "type": "string", "description": "* `venafi_cloud` - Venafi TLS Protect Cloud (VaaS)\n* `venafi_tpp` - Venafi TLS Protect Data Center (TPP)\n* `keyfactor` - Keyfactor Command\n* `appviewx` - AppViewX CERT+" }, "CloudAccountRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "provider": { "$ref": "#/components/schemas/CloudAccountProviderEnum" }, "description": { "type": "string", "maxLength": 500 }, "enabled": { "type": "boolean" }, "account_id": { "type": "string", "description": "AWS Account ID / Azure Subscription ID / GCP Project ID", "maxLength": 200 }, "regions": { "description": "Regions to scope sync/monitoring (empty = all)" }, "aws_access_key": { "type": "string", "description": "IAM Access Key ID", "maxLength": 500 }, "aws_secret_key": { "type": "string", "writeOnly": true }, "aws_role_arn": { "type": "string", "description": "Optional IAM Role ARN to assume (cross-account)", "maxLength": 500 }, "azure_tenant_id": { "type": "string", "maxLength": 200 }, "azure_client_id": { "type": "string", "description": "App registration (Service Principal) Client ID", "maxLength": 200 }, "azure_client_secret": { "type": "string", "writeOnly": true }, "gcp_service_account_json": { "type": "string", "writeOnly": true } }, "required": [ "name", "provider" ] }, "CloudAccountProviderEnum": { "enum": [ "aws", "azure", "gcp" ], "type": "string", "description": "* `aws` - Amazon Web Services\n* `azure` - Microsoft Azure\n* `gcp` - Google Cloud Platform" }, "VSphereSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "vCenter base URL, e.g. https://vcenter.corp.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "datacenter": { "type": "string", "description": "Filter by datacenter name (leave blank for all)", "maxLength": 200 }, "extra_config": {}, "enabled": { "type": "boolean" } }, "required": [ "name", "url", "username" ] }, "AuthTypeEnum": { "enum": [ "basic", "oauth" ], "type": "string", "description": "* `basic` - Basic Auth (username/password)\n* `oauth` - OAuth 2.0 (password grant \u2014 requires OAuth app in ServiceNow)" }, "ControllerSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "controller_type": { "$ref": "#/components/schemas/ControllerTypeEnum" }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://avi-ctrl.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "tenant": { "type": "string", "description": "Avi: tenant name (default \"admin\"). APIC: leave blank.", "maxLength": 200 }, "extra_config": {}, "enabled": { "type": "boolean" } }, "required": [ "controller_type", "name", "url" ] }, "AuthProviderSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "provider": { "$ref": "#/components/schemas/AuthProviderSourceProviderEnum" }, "provider_label": { "type": "string", "readOnly": true }, "base_url": { "type": "string", "description": "API base URL. ISE: https://ise.corp:9060 (ERS) \u00b7 Okta: https://org.okta.com \u00b7 ClearPass: https://cppm.corp \u00b7 Entra: https://graph.microsoft.com", "maxLength": 500 }, "host": { "type": "string", "description": "Host for RADIUS/TACACS+/LDAP providers (when there is no HTTPS API)", "maxLength": 255 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "e.g. 1812 RADIUS \u00b7 49 TACACS+ \u00b7 636 LDAPS \u00b7 9060 ISE ERS" }, "username": { "type": "string", "description": "API/admin user or bind DN (ISE ERS admin, LDAP bind DN, ...)", "maxLength": 200 }, "vault_managed": { "type": "boolean", "description": "Vault and rotate the accounts sourced from this provider" }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/AuthProviderSourceStatusEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "provider_label", "status", "status_msg", "updated_at" ] }, "PaginatedSCMCommitList": { "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/SCMCommit" } } } }, "OsTypeEnum": { "enum": [ "windows", "linux" ], "type": "string", "description": "* `windows` - Windows\n* `linux` - Linux" }, "CertPlatformSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "platform_type": { "$ref": "#/components/schemas/PlatformTypeEnum" }, "base_url": { "type": "string", "minLength": 1, "description": "Venafi Cloud: https://api.venafi.cloud | TPP: https://tpp.corp.com | Keyfactor: https://kf.corp.com/KeyfactorAPI | AppViewX: https://avx.corp.com", "maxLength": 500 }, "api_key": { "type": "string", "writeOnly": true }, "username": { "type": "string", "description": "Venafi TPP / Keyfactor / AppViewX username", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "base_url", "name" ] }, "PaginatedHSMSourceList": { "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/HSMSource" } } } }, "SCMSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "scm_type": { "$ref": "#/components/schemas/ScmTypeEnum" }, "url": { "type": "string", "description": "Leave blank for github.com / gitlab.com. Required for self-hosted.", "maxLength": 500 }, "username": { "type": "string", "description": "GitHub username or org (used to list repos)", "maxLength": 200 }, "default_branch": { "type": "string", "maxLength": 100 }, "watch_repos": { "description": "List of owner/repo slugs to watch, e.g. [\"acme/network-configs\"]" }, "extra_config": {}, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status54bEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_synced": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "commit_count": { "type": "string", "readOnly": true } }, "required": [ "commit_count", "created_at", "id", "last_synced", "name", "status", "status_msg", "updated_at" ] }, "PagerSourceVendorEnum": { "enum": [ "pagerduty", "opsgenie", "victorops", "xmatters", "onpage" ], "type": "string", "description": "* `pagerduty` - PagerDuty\n* `opsgenie` - Opsgenie (Atlassian)\n* `victorops` - Splunk On-Call / VictorOps\n* `xmatters` - xMatters\n* `onpage` - OnPage" }, "AuthProviderSourceProviderEnum": { "enum": [ "cisco_ise", "cisco_acs", "aruba_clearpass", "forescout", "microsoft_nps", "freeradius", "radius_generic", "tacacs_generic", "microsoft_ad", "openldap", "microsoft_entra", "okta", "ping", "forgerock", "cisco_duo", "rsa_securid", "cyberark", "beyondtrust", "delinea", "hashicorp_vault", "other" ], "type": "string", "description": "* `cisco_ise` - Cisco Identity Services Engine (ISE)\n* `cisco_acs` - Cisco Secure ACS (TACACS+)\n* `aruba_clearpass` - Aruba ClearPass Policy Manager\n* `forescout` - Forescout eyeSight\n* `microsoft_nps` - Microsoft NPS (RADIUS)\n* `freeradius` - FreeRADIUS\n* `radius_generic` - RADIUS (generic)\n* `tacacs_generic` - TACACS+ (generic)\n* `microsoft_ad` - Microsoft Active Directory\n* `openldap` - OpenLDAP / LDAP\n* `microsoft_entra` - Microsoft Entra ID (Azure AD)\n* `okta` - Okta\n* `ping` - Ping Identity (PingFederate / PingOne)\n* `forgerock` - ForgeRock / PingAM\n* `cisco_duo` - Cisco Duo\n* `rsa_securid` - RSA SecurID\n* `cyberark` - CyberArk PAM\n* `beyondtrust` - BeyondTrust\n* `delinea` - Delinea (Thycotic) Secret Server\n* `hashicorp_vault` - HashiCorp Vault\n* `other` - Other" }, "PagerSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "vendor": { "$ref": "#/components/schemas/PagerSourceVendorEnum" }, "routing_key": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "url": { "type": "string", "description": "Override base URL (e.g. https://api.eu.opsgenie.com or xMatters instance URL)", "maxLength": 500 }, "default_severity": { "$ref": "#/components/schemas/DefaultSeverityEnum" }, "enabled": { "type": "boolean" } }, "required": [ "name" ] }, "PaginatedCrowdStrikeSourceList": { "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/CrowdStrikeSource" } } } }, "ConfluenceSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "deployment": { "$ref": "#/components/schemas/ConfluenceSourceDeploymentEnum" }, "url": { "type": "string", "description": "Cloud: https://yourorg.atlassian.net | Server: https://confluence.corp.com", "maxLength": 500 }, "username": { "type": "string", "description": "Your Atlassian account email (Cloud) or local username (Server)", "maxLength": 200 }, "default_space": { "type": "string", "description": "Space key used when no space is specified, e.g. NET or NETOPS", "maxLength": 100 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "url", "username" ] }, "PatchedControllerSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "controller_type": { "$ref": "#/components/schemas/ControllerTypeEnum" }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://avi-ctrl.corp.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "tenant": { "type": "string", "description": "Avi: tenant name (default \"admin\"). APIC: leave blank.", "maxLength": 200 }, "extra_config": {}, "enabled": { "type": "boolean" } } }, "PaginatedIPAMSourceList": { "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/IPAMSource" } } } }, "PatchedCloudAccountRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "provider": { "$ref": "#/components/schemas/CloudAccountProviderEnum" }, "description": { "type": "string", "maxLength": 500 }, "enabled": { "type": "boolean" }, "account_id": { "type": "string", "description": "AWS Account ID / Azure Subscription ID / GCP Project ID", "maxLength": 200 }, "regions": { "description": "Regions to scope sync/monitoring (empty = all)" }, "aws_access_key": { "type": "string", "description": "IAM Access Key ID", "maxLength": 500 }, "aws_secret_key": { "type": "string", "writeOnly": true }, "aws_role_arn": { "type": "string", "description": "Optional IAM Role ARN to assume (cross-account)", "maxLength": 500 }, "azure_tenant_id": { "type": "string", "maxLength": 200 }, "azure_client_id": { "type": "string", "description": "App registration (Service Principal) Client ID", "maxLength": 200 }, "azure_client_secret": { "type": "string", "writeOnly": true }, "gcp_service_account_json": { "type": "string", "writeOnly": true } } }, "JiraSourceDeploymentEnum": { "enum": [ "cloud", "server" ], "type": "string", "description": "* `cloud` - Jira Cloud (atlassian.net)\n* `server` - Jira Server / Data Center" }, "HSMSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "hsm_type": { "$ref": "#/components/schemas/HsmTypeEnum" }, "host": { "type": "string", "description": "Hostname or IP of HSM / management endpoint", "maxLength": 500 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Network port (Luna: 1792, nShield: 9004, REST: 443)" }, "partition": { "type": "string", "description": "Partition name, slot label, or key group (vendor-specific)", "maxLength": 200 }, "username": { "type": "string", "description": "Admin / CO username", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Vendor-specific options (e.g. client cert path, cluster ID, region)" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/HSMSourceStatusEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "host", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at" ] }, "PatchedRundeckSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://rundeck.corp.com", "maxLength": 500 }, "api_token": { "type": "string", "writeOnly": true }, "api_version": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Rundeck API version to use (14+ for modern features)" }, "default_project": { "type": "string", "description": "Optional default project name for job lookups", "maxLength": 200 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "PaginatedRundeckSourceList": { "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/RundeckSource" } } } }, "JiraSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "deployment": { "$ref": "#/components/schemas/JiraSourceDeploymentEnum" }, "url": { "type": "string", "minLength": 1, "description": "Cloud: https://yourorg.atlassian.net | Server: https://jira.corp.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "description": "Your Atlassian account email (Cloud) or local username (Server)", "maxLength": 200 }, "api_token": { "type": "string", "writeOnly": true }, "default_project": { "type": "string", "description": "Project key used when no project is specified, e.g. NET or OPS", "maxLength": 50 }, "default_issue_type": { "type": "string", "minLength": 1, "description": "Default issue type: Task, Bug, Story, etc.", "maxLength": 100 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name", "url", "username" ] }, "ControllerTypeEnum": { "enum": [ "avi", "panorama", "nsx_mgr", "apic", "other" ], "type": "string", "description": "* `avi` - VMware NSX ALB (Avi Controller)\n* `panorama` - Palo Alto Panorama\n* `nsx_mgr` - VMware NSX-T Manager\n* `apic` - Cisco ACI APIC\n* `other` - Other" }, "HSMSourceStatusEnum": { "enum": [ "unchecked", "ok", "error" ], "type": "string", "description": "* `unchecked` - Not checked\n* `ok` - Reachable\n* `error` - Connection error" }, "AuthProviderSourceStatusEnum": { "enum": [ "unchecked", "ok", "error" ], "type": "string", "description": "* `unchecked` - Not tested\n* `ok` - Reachable\n* `error` - Connection error" }, "VSphereVMProfileRequest": { "type": "object", "properties": { "vsphere_source": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 }, "template_name": { "type": "string", "minLength": 1, "description": "Template VM display name in vCenter", "maxLength": 200 }, "datacenter": { "type": "string", "maxLength": 200 }, "cluster": { "type": "string", "minLength": 1, "maxLength": 200 }, "datastore": { "type": "string", "minLength": 1, "maxLength": 200 }, "folder": { "type": "string", "maxLength": 200 }, "network": { "type": "string", "maxLength": 200 }, "resource_pool": { "type": "string", "maxLength": 200 }, "cpu_count": { "type": "integer", "maximum": 32767, "minimum": 0 }, "memory_mb": { "type": "integer", "maximum": 2147483647, "minimum": 0, "description": "Memory in MiB" }, "disk_gb": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true, "description": "Disk size in GB (blank = keep template size)" }, "customization_spec": { "type": "string", "maxLength": 200 }, "os_type": { "oneOf": [ { "$ref": "#/components/schemas/OsTypeEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "notes": { "type": "string" } }, "required": [ "cluster", "datastore", "name", "template_name", "vsphere_source" ] }, "SIEMSourceSourceTypeEnum": { "enum": [ "splunk", "sentinel", "qradar", "elastic", "sumo", "datadog", "wazuh", "chronicle", "other" ], "type": "string", "description": "* `splunk` - Splunk Enterprise / Cloud\n* `sentinel` - Microsoft Sentinel\n* `qradar` - IBM QRadar\n* `elastic` - Elastic SIEM / OpenSearch\n* `sumo` - Sumo Logic\n* `datadog` - Datadog SIEM\n* `wazuh` - Wazuh\n* `chronicle` - Google Chronicle\n* `other` - Other / Generic" }, "AIProvider": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "provider_type": { "$ref": "#/components/schemas/AIProviderProviderTypeEnum" }, "base_url": { "type": "string", "description": "Required for openai_compatible \u2014 e.g. http://localhost:11434/v1", "maxLength": 500 }, "model": { "type": "string", "description": "Leave blank to use provider default", "maxLength": 200 }, "is_default": { "type": "boolean", "description": "Only one provider is used at a time" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "status", "status_msg", "updated_at" ] }, "ServiceNowInstanceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://dev12345.service-now.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "auth_type": { "$ref": "#/components/schemas/AuthTypeEnum" }, "oauth_client_id": { "type": "string", "maxLength": 500 }, "oauth_client_secret": { "type": "string", "writeOnly": true }, "is_default": { "type": "boolean" }, "notes": { "type": "string" } }, "required": [ "name", "url", "username" ] }, "PaginatedJiraSourceList": { "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/JiraSource" } } } }, "PatchedAIProviderRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "provider_type": { "$ref": "#/components/schemas/AIProviderProviderTypeEnum" }, "base_url": { "type": "string", "description": "Required for openai_compatible \u2014 e.g. http://localhost:11434/v1", "maxLength": 500 }, "model": { "type": "string", "description": "Leave blank to use provider default", "maxLength": 200 }, "api_key": { "type": "string", "writeOnly": true }, "is_default": { "type": "boolean", "description": "Only one provider is used at a time" }, "enabled": { "type": "boolean" } } }, "ServiceNowInstance": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 200 }, "url": { "type": "string", "description": "Base URL, e.g. https://dev12345.service-now.com", "maxLength": 500 }, "username": { "type": "string", "maxLength": 200 }, "auth_type": { "$ref": "#/components/schemas/AuthTypeEnum" }, "oauth_client_id": { "type": "string", "maxLength": 500 }, "is_default": { "type": "boolean" }, "notes": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "name", "updated_at", "url", "username" ] }, "BlankEnum": { "enum": [ "" ] }, "PatchedVSphereVMProfileRequest": { "type": "object", "properties": { "vsphere_source": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "maxLength": 500 }, "template_name": { "type": "string", "minLength": 1, "description": "Template VM display name in vCenter", "maxLength": 200 }, "datacenter": { "type": "string", "maxLength": 200 }, "cluster": { "type": "string", "minLength": 1, "maxLength": 200 }, "datastore": { "type": "string", "minLength": 1, "maxLength": 200 }, "folder": { "type": "string", "maxLength": 200 }, "network": { "type": "string", "maxLength": 200 }, "resource_pool": { "type": "string", "maxLength": 200 }, "cpu_count": { "type": "integer", "maximum": 32767, "minimum": 0 }, "memory_mb": { "type": "integer", "maximum": 2147483647, "minimum": 0, "description": "Memory in MiB" }, "disk_gb": { "type": "integer", "maximum": 2147483647, "minimum": 0, "nullable": true, "description": "Disk size in GB (blank = keep template size)" }, "customization_spec": { "type": "string", "maxLength": 200 }, "os_type": { "oneOf": [ { "$ref": "#/components/schemas/OsTypeEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "notes": { "type": "string" } } }, "PatchedServiceNowInstanceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "url": { "type": "string", "minLength": 1, "description": "Base URL, e.g. https://dev12345.service-now.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "auth_type": { "$ref": "#/components/schemas/AuthTypeEnum" }, "oauth_client_id": { "type": "string", "maxLength": 500 }, "oauth_client_secret": { "type": "string", "writeOnly": true }, "is_default": { "type": "boolean" }, "notes": { "type": "string" } } }, "PaginatedThousandEyesSourceList": { "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/ThousandEyesSource" } } } }, "PaginatedVSphereSourceList": { "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/VSphereSource" } } } }, "ThousandEyesSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "account_group_id": { "type": "string", "description": "Account Group ID (aid) to scope requests. Leave blank to use the default group.", "maxLength": 100 }, "base_url": { "type": "string", "description": "API base URL. Change only for sovereign cloud deployments.", "maxLength": 500 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true, "description": "Discovered: account group name, test count, agent count" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at" ] }, "ConfluenceSourceDeploymentEnum": { "enum": [ "cloud", "server" ], "type": "string", "description": "* `cloud` - Confluence Cloud (atlassian.net)\n* `server` - Confluence Server / Data Center" }, "ConfluenceSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "deployment": { "$ref": "#/components/schemas/ConfluenceSourceDeploymentEnum" }, "url": { "type": "string", "minLength": 1, "description": "Cloud: https://yourorg.atlassian.net | Server: https://confluence.corp.com", "maxLength": 500 }, "username": { "type": "string", "minLength": 1, "description": "Your Atlassian account email (Cloud) or local username (Server)", "maxLength": 200 }, "api_token": { "type": "string", "writeOnly": true }, "default_space": { "type": "string", "description": "Space key used when no space is specified, e.g. NET or NETOPS", "maxLength": 100 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "name", "url", "username" ] }, "SlackSource": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "default_channel": { "type": "string", "description": "Default channel ID or name, e.g. #network-alerts or C0123456789", "maxLength": 200 }, "workspace_name": { "type": "string", "readOnly": true }, "enabled": { "type": "boolean" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0aeEnum" } ], "readOnly": true }, "status_msg": { "type": "string", "readOnly": true }, "last_tested": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "metadata": { "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created_at", "id", "last_tested", "metadata", "name", "status", "status_msg", "updated_at", "workspace_name" ] }, "HSMSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hsm_type": { "$ref": "#/components/schemas/HsmTypeEnum" }, "host": { "type": "string", "minLength": 1, "description": "Hostname or IP of HSM / management endpoint", "maxLength": 500 }, "port": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Network port (Luna: 1792, nShield: 9004, REST: 443)" }, "partition": { "type": "string", "description": "Partition name, slot label, or key group (vendor-specific)", "maxLength": 200 }, "username": { "type": "string", "description": "Admin / CO username", "maxLength": 200 }, "password": { "type": "string", "writeOnly": true }, "pin": { "type": "string", "writeOnly": true }, "api_key": { "type": "string", "writeOnly": true }, "verify_ssl": { "type": "boolean" }, "extra_config": { "description": "Vendor-specific options (e.g. client cert path, cluster ID, region)" }, "enabled": { "type": "boolean" } }, "required": [ "host", "name" ] }, "PaginatedCertPlatformSourceList": { "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/CertPlatformSource" } } } }, "HsmTypeEnum": { "enum": [ "thales_luna", "thales_payshield", "entrust_nshield", "utimaco", "futurex", "securosys", "yubihsm", "aws_cloudhsm", "azure_hsm", "google_cloud_hsm", "ibm_cloudhsm", "other" ], "type": "string", "description": "* `thales_luna` - Thales Luna Network HSM\n* `thales_payshield` - Thales payShield 10K\n* `entrust_nshield` - Entrust nShield Connect\n* `utimaco` - Utimaco SecurityServer\n* `futurex` - Futurex KMES Series\n* `securosys` - Securosys Primus HSM\n* `yubihsm` - Yubico YubiHSM 2\n* `aws_cloudhsm` - AWS CloudHSM\n* `azure_hsm` - Azure Dedicated HSM / Managed HSM\n* `google_cloud_hsm` - Google Cloud HSM (Cloud KMS)\n* `ibm_cloudhsm` - IBM Cloud HSM\n* `other` - Other / Generic PKCS#11" }, "ScmTypeEnum": { "enum": [ "github", "gitlab", "bitbucket", "gitea", "azure_devops" ], "type": "string", "description": "* `github` - GitHub\n* `gitlab` - GitLab\n* `bitbucket` - Bitbucket\n* `gitea` - Gitea / Forgejo\n* `azure_devops` - Azure DevOps" }, "PatchedThousandEyesSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "oauth_token": { "type": "string", "writeOnly": true }, "account_group_id": { "type": "string", "description": "Account Group ID (aid) to scope requests. Leave blank to use the default group.", "maxLength": 100 }, "base_url": { "type": "string", "minLength": 1, "description": "API base URL. Change only for sovereign cloud deployments.", "maxLength": 500 }, "verify_ssl": { "type": "boolean" }, "enabled": { "type": "boolean" } } }, "PaginatedSCMSourceList": { "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/SCMSource" } } } }, "SlackSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "bot_token": { "type": "string", "writeOnly": true }, "webhook_url": { "type": "string", "writeOnly": true }, "signing_secret": { "type": "string", "writeOnly": true }, "default_channel": { "type": "string", "description": "Default channel ID or name, e.g. #network-alerts or C0123456789", "maxLength": 200 }, "enabled": { "type": "boolean" } }, "required": [ "name" ] }, "PatchedSlackSourceRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "bot_token": { "type": "string", "writeOnly": true }, "webhook_url": { "type": "string", "writeOnly": true }, "signing_secret": { "type": "string", "writeOnly": true }, "default_channel": { "type": "string", "description": "Default channel ID or name, e.g. #network-alerts or C0123456789", "maxLength": 200 }, "enabled": { "type": "boolean" } } } } } }