API Reference

Integrations API

Third-party integrations — Slack, Jira, ServiceNow, vSphere, SIEM, SCM, Rundeck, AWX, CrowdStrike, cloud, and cert platforms. Auto-generated from the platform OpenAPI schema so it matches the running API.

REST API for this feature — 182 operations across 98 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).

Base URL https://<your-versus-host>/api · Auth Authorization: Bearer <JWT> (from POST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.

Ai providers

GET /api/integrations/ai-providers/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
searchquerynostringA search term.

Responses: 200 → AIProvider[]

POST /api/integrations/ai-providers/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): AIProviderRequest

Responses: 201 → AIProvider

GET /api/integrations/ai-providers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ai provider.

Responses: 200 → AIProvider

PUT /api/integrations/ai-providers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ai provider.

Request body (application/json): AIProviderRequest

Responses: 200 → AIProvider

PATCH /api/integrations/ai-providers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ai provider.

Request body (application/json): PatchedAIProviderRequest

Responses: 200 → AIProvider

DELETE /api/integrations/ai-providers/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ai provider.

Responses: 204

POST /api/integrations/ai-providers/{id}/set_default/

Mark this provider as the active default; clears the flag on all others.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ai provider.

Request body (application/json): AIProviderRequest

Responses: 200 → AIProvider

POST /api/integrations/ai-providers/{id}/test/

Send a minimal prompt to verify connectivity and auth.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ai provider.

Request body (application/json): AIProviderRequest

Responses: 200 → AIProvider


Auth providers

GET /api/integrations/auth-providers/

Authentication / identity provider sources — AAA, NAC, IdP, directory, PAM.

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
providerquerynostring* cisco_ise - Cisco Identity Services Engine (ISE)
searchquerynostringA search term.
vault_managedquerynoboolean

Responses: 200 → PaginatedAuthProviderSourceList

POST /api/integrations/auth-providers/

Authentication / identity provider sources — AAA, NAC, IdP, directory, PAM.

Request body (application/json): AuthProviderSourceRequest

Responses: 201 → AuthProviderSource

GET /api/integrations/auth-providers/{id}/

Authentication / identity provider sources — AAA, NAC, IdP, directory, PAM.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this auth provider source.

Responses: 200 → AuthProviderSource

PUT /api/integrations/auth-providers/{id}/

Authentication / identity provider sources — AAA, NAC, IdP, directory, PAM.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this auth provider source.

Request body (application/json): AuthProviderSourceRequest

Responses: 200 → AuthProviderSource

PATCH /api/integrations/auth-providers/{id}/

Authentication / identity provider sources — AAA, NAC, IdP, directory, PAM.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this auth provider source.

Request body (application/json): PatchedAuthProviderSourceRequest

Responses: 200 → AuthProviderSource

DELETE /api/integrations/auth-providers/{id}/

Authentication / identity provider sources — AAA, NAC, IdP, directory, PAM.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this auth provider source.

Responses: 204

POST /api/integrations/auth-providers/{id}/test_connection/

Reachability probe: confirm the provider endpoint is reachable. A full

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this auth provider source.

Request body (application/json): AuthProviderSourceRequest

Responses: 200 → AuthProviderSource


Awx sources

GET /api/integrations/awx-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedAWXSourceList

POST /api/integrations/awx-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): AWXSourceRequest

Responses: 201 → AWXSource

GET /api/integrations/awx-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this awx source.

Responses: 200 → AWXSource

PUT /api/integrations/awx-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this awx source.

Request body (application/json): AWXSourceRequest

Responses: 200 → AWXSource

PATCH /api/integrations/awx-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this awx source.

Request body (application/json): PatchedAWXSourceRequest

Responses: 200 → AWXSource

DELETE /api/integrations/awx-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this awx source.

Responses: 204

POST /api/integrations/awx-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this awx source.

Request body (application/json): AWXSourceRequest

Responses: 200 → AWXSource


Cert platforms

GET /api/integrations/cert-platforms/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
platform_typequerynostring* venafi_cloud - Venafi TLS Protect Cloud (VaaS)
searchquerynostringA search term.

Responses: 200 → PaginatedCertPlatformSourceList

POST /api/integrations/cert-platforms/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CertPlatformSourceRequest

Responses: 201 → CertPlatformSource

GET /api/integrations/cert-platforms/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Responses: 200 → CertPlatformSource

PUT /api/integrations/cert-platforms/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): CertPlatformSourceRequest

Responses: 200 → CertPlatformSource

PATCH /api/integrations/cert-platforms/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): PatchedCertPlatformSourceRequest

Responses: 200 → CertPlatformSource

DELETE /api/integrations/cert-platforms/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Responses: 204

GET /api/integrations/cert-platforms/{id}/certificates/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Responses: 200 → CertPlatformSource

POST /api/integrations/cert-platforms/{id}/renew_certificate/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): CertPlatformSourceRequest

Responses: 200 → CertPlatformSource

POST /api/integrations/cert-platforms/{id}/request_certificate/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): CertPlatformSourceRequest

Responses: 200 → CertPlatformSource

POST /api/integrations/cert-platforms/{id}/revoke_certificate/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): CertPlatformSourceRequest

Responses: 200 → CertPlatformSource

POST /api/integrations/cert-platforms/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): CertPlatformSourceRequest

Responses: 200 → CertPlatformSource

POST /api/integrations/cert-platforms/{id}/trigger_workflow/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Request body (application/json): CertPlatformSourceRequest

Responses: 200 → CertPlatformSource

GET /api/integrations/cert-platforms/{id}/workflows/

List available workflows (AppViewX only).

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Responses: 200 → CertPlatformSource

GET /api/integrations/cert-platforms/{id}/zones/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cert platform source.

Responses: 200 → CertPlatformSource


Cloud accounts

GET /api/integrations/cloud-accounts/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCloudAccountList

POST /api/integrations/cloud-accounts/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CloudAccountRequest

Responses: 201 → CloudAccount

GET /api/integrations/cloud-accounts/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cloud account.

Responses: 200 → CloudAccount

PUT /api/integrations/cloud-accounts/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cloud account.

Request body (application/json): CloudAccountRequest

Responses: 200 → CloudAccount

PATCH /api/integrations/cloud-accounts/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cloud account.

Request body (application/json): PatchedCloudAccountRequest

Responses: 200 → CloudAccount

DELETE /api/integrations/cloud-accounts/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cloud account.

Responses: 204

POST /api/integrations/cloud-accounts/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this cloud account.

Request body (application/json): CloudAccountRequest

Responses: 200 → CloudAccount


Confluence sources

GET /api/integrations/confluence-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
deploymentquerynostring* cloud - Confluence Cloud (atlassian.net)
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedConfluenceSourceList

POST /api/integrations/confluence-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ConfluenceSourceRequest

Responses: 201 → ConfluenceSource

GET /api/integrations/confluence-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this confluence source.

Responses: 200 → ConfluenceSource

PUT /api/integrations/confluence-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this confluence source.

Request body (application/json): ConfluenceSourceRequest

Responses: 200 → ConfluenceSource

PATCH /api/integrations/confluence-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this confluence source.

Request body (application/json): PatchedConfluenceSourceRequest

Responses: 200 → ConfluenceSource

DELETE /api/integrations/confluence-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this confluence source.

Responses: 204

POST /api/integrations/confluence-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this confluence source.

Request body (application/json): ConfluenceSourceRequest

Responses: 200 → ConfluenceSource


Controller sources

GET /api/integrations/controller-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
controller_typequerynostring* avi - VMware NSX ALB (Avi Controller)
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedControllerSourceList

POST /api/integrations/controller-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ControllerSourceRequest

Responses: 201 → ControllerSource

GET /api/integrations/controller-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Responses: 200 → ControllerSource

PUT /api/integrations/controller-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Request body (application/json): ControllerSourceRequest

Responses: 200 → ControllerSource

PATCH /api/integrations/controller-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Request body (application/json): PatchedControllerSourceRequest

Responses: 200 → ControllerSource

DELETE /api/integrations/controller-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Responses: 204

GET /api/integrations/controller-sources/{id}/avi_clouds/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Responses: 200 → ControllerSource

GET /api/integrations/controller-sources/{id}/avi_se_groups/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Responses: 200 → ControllerSource

GET /api/integrations/controller-sources/{id}/avi_tier1_lrs/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Responses: 200 → ControllerSource

POST /api/integrations/controller-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this controller source.

Request body (application/json): ControllerSourceRequest

Responses: 200 → ControllerSource


Crowdstrike sources

GET /api/integrations/crowdstrike-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedCrowdStrikeSourceList

POST /api/integrations/crowdstrike-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): CrowdStrikeSourceRequest

Responses: 201 → CrowdStrikeSource

GET /api/integrations/crowdstrike-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this crowd strike source.

Responses: 200 → CrowdStrikeSource

PUT /api/integrations/crowdstrike-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this crowd strike source.

Request body (application/json): CrowdStrikeSourceRequest

Responses: 200 → CrowdStrikeSource

PATCH /api/integrations/crowdstrike-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this crowd strike source.

Request body (application/json): PatchedCrowdStrikeSourceRequest

Responses: 200 → CrowdStrikeSource

DELETE /api/integrations/crowdstrike-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this crowd strike source.

Responses: 204

POST /api/integrations/crowdstrike-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this crowd strike source.

Request body (application/json): CrowdStrikeSourceRequest

Responses: 200 → CrowdStrikeSource


Hsm sources

GET /api/integrations/hsm-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
hsm_typequerynostring* thales_luna - Thales Luna Network HSM
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedHSMSourceList

POST /api/integrations/hsm-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): HSMSourceRequest

Responses: 201 → HSMSource

GET /api/integrations/hsm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this hsm source.

Responses: 200 → HSMSource

PUT /api/integrations/hsm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this hsm source.

Request body (application/json): HSMSourceRequest

Responses: 200 → HSMSource

PATCH /api/integrations/hsm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this hsm source.

Request body (application/json): PatchedHSMSourceRequest

Responses: 200 → HSMSource

DELETE /api/integrations/hsm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this hsm source.

Responses: 204

POST /api/integrations/hsm-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this hsm source.

Request body (application/json): HSMSourceRequest

Responses: 200 → HSMSource


Ipam sources

GET /api/integrations/ipam-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedIPAMSourceList

POST /api/integrations/ipam-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): IPAMSourceRequest

Responses: 201 → IPAMSource

GET /api/integrations/ipam-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ipam source.

Responses: 200 → IPAMSource

PUT /api/integrations/ipam-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ipam source.

Request body (application/json): IPAMSourceRequest

Responses: 200 → IPAMSource

PATCH /api/integrations/ipam-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ipam source.

Request body (application/json): PatchedIPAMSourceRequest

Responses: 200 → IPAMSource

DELETE /api/integrations/ipam-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ipam source.

Responses: 204

POST /api/integrations/ipam-sources/{id}/set_default/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ipam source.

Request body (application/json): IPAMSourceRequest

Responses: 200 → IPAMSource

POST /api/integrations/ipam-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this ipam source.

Request body (application/json): IPAMSourceRequest

Responses: 200 → IPAMSource


Jira sources

GET /api/integrations/jira-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
deploymentquerynostring* cloud - Jira Cloud (atlassian.net)
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedJiraSourceList

POST /api/integrations/jira-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): JiraSourceRequest

Responses: 201 → JiraSource

GET /api/integrations/jira-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this jira source.

Responses: 200 → JiraSource

PUT /api/integrations/jira-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this jira source.

Request body (application/json): JiraSourceRequest

Responses: 200 → JiraSource

PATCH /api/integrations/jira-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this jira source.

Request body (application/json): PatchedJiraSourceRequest

Responses: 200 → JiraSource

DELETE /api/integrations/jira-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this jira source.

Responses: 204

POST /api/integrations/jira-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this jira source.

Request body (application/json): JiraSourceRequest

Responses: 200 → JiraSource


Network overview

GET /api/integrations/network-overview/

Aggregate view: devices + SIEM events + SCM commits for the command-centre page.

Responses: 200


Pager sources

GET /api/integrations/pager-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.
vendorquerynostring* pagerduty - PagerDuty

Responses: 200 → PaginatedPagerSourceList

POST /api/integrations/pager-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): PagerSourceRequest

Responses: 201 → PagerSource

GET /api/integrations/pager-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Responses: 200 → PagerSource

PUT /api/integrations/pager-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Request body (application/json): PagerSourceRequest

Responses: 200 → PagerSource

PATCH /api/integrations/pager-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Request body (application/json): PatchedPagerSourceRequest

Responses: 200 → PagerSource

DELETE /api/integrations/pager-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Responses: 204

POST /api/integrations/pager-sources/{id}/resolve/

Resolve an incident by its dedup_key.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Request body (application/json): PagerSourceRequest

Responses: 200 → PagerSource

POST /api/integrations/pager-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Request body (application/json): PagerSourceRequest

Responses: 200 → PagerSource

POST /api/integrations/pager-sources/{id}/trigger/

Trigger a test/manual incident from the UI.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this pager source.

Request body (application/json): PagerSourceRequest

Responses: 200 → PagerSource


Rapid7 sources

GET /api/integrations/rapid7-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedRapid7SourceList

POST /api/integrations/rapid7-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): Rapid7SourceRequest

Responses: 201 → Rapid7Source

GET /api/integrations/rapid7-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rapid7 source.

Responses: 200 → Rapid7Source

PUT /api/integrations/rapid7-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rapid7 source.

Request body (application/json): Rapid7SourceRequest

Responses: 200 → Rapid7Source

PATCH /api/integrations/rapid7-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rapid7 source.

Request body (application/json): PatchedRapid7SourceRequest

Responses: 200 → Rapid7Source

DELETE /api/integrations/rapid7-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rapid7 source.

Responses: 204

POST /api/integrations/rapid7-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rapid7 source.

Request body (application/json): Rapid7SourceRequest

Responses: 200 → Rapid7Source


Rundeck sources

GET /api/integrations/rundeck-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedRundeckSourceList

POST /api/integrations/rundeck-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): RundeckSourceRequest

Responses: 201 → RundeckSource

GET /api/integrations/rundeck-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rundeck source.

Responses: 200 → RundeckSource

PUT /api/integrations/rundeck-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rundeck source.

Request body (application/json): RundeckSourceRequest

Responses: 200 → RundeckSource

PATCH /api/integrations/rundeck-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rundeck source.

Request body (application/json): PatchedRundeckSourceRequest

Responses: 200 → RundeckSource

DELETE /api/integrations/rundeck-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rundeck source.

Responses: 204

POST /api/integrations/rundeck-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this rundeck source.

Request body (application/json): RundeckSourceRequest

Responses: 200 → RundeckSource


Scm commits

GET /api/integrations/scm-commits/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSCMCommitList

GET /api/integrations/scm-commits/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm commit.

Responses: 200 → SCMCommit


Scm sources

GET /api/integrations/scm-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSCMSourceList

POST /api/integrations/scm-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): SCMSourceRequest

Responses: 201 → SCMSource

GET /api/integrations/scm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Responses: 200 → SCMSource

PUT /api/integrations/scm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Request body (application/json): SCMSourceRequest

Responses: 200 → SCMSource

PATCH /api/integrations/scm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Request body (application/json): PatchedSCMSourceRequest

Responses: 200 → SCMSource

DELETE /api/integrations/scm-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Responses: 204

GET /api/integrations/scm-sources/{id}/list_repos/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Responses: 200 → SCMSource

GET /api/integrations/scm-sources/{id}/recent_commits/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Responses: 200 → SCMSource

POST /api/integrations/scm-sources/{id}/sync/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Request body (application/json): SCMSourceRequest

Responses: 200 → SCMSource

POST /api/integrations/scm-sources/{id}/sync_async/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Request body (application/json): SCMSourceRequest

Responses: 200 → SCMSource

POST /api/integrations/scm-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this scm source.

Request body (application/json): SCMSourceRequest

Responses: 200 → SCMSource


Siem events

GET /api/integrations/siem-events/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSIEMEventList

GET /api/integrations/siem-events/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem event.

Responses: 200 → SIEMEvent

PATCH /api/integrations/siem-events/{id}/set_status/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem event.

Request body (application/json): PatchedSIEMEventRequest

Responses: 200 → SIEMEvent


Siem sources

GET /api/integrations/siem-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSIEMSourceList

POST /api/integrations/siem-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): SIEMSourceRequest

Responses: 201 → SIEMSource

GET /api/integrations/siem-sources/summary/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Responses: 200 → SIEMSource

GET /api/integrations/siem-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Responses: 200 → SIEMSource

PUT /api/integrations/siem-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Request body (application/json): SIEMSourceRequest

Responses: 200 → SIEMSource

PATCH /api/integrations/siem-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Request body (application/json): PatchedSIEMSourceRequest

Responses: 200 → SIEMSource

DELETE /api/integrations/siem-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Responses: 204

POST /api/integrations/siem-sources/{id}/sync_events/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Request body (application/json): SIEMSourceRequest

Responses: 200 → SIEMSource

POST /api/integrations/siem-sources/{id}/sync_events_async/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Request body (application/json): SIEMSourceRequest

Responses: 200 → SIEMSource

POST /api/integrations/siem-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this siem source.

Request body (application/json): SIEMSourceRequest

Responses: 200 → SIEMSource


Slack sources

GET /api/integrations/slack-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedSlackSourceList

POST /api/integrations/slack-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): SlackSourceRequest

Responses: 201 → SlackSource

GET /api/integrations/slack-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this slack source.

Responses: 200 → SlackSource

PUT /api/integrations/slack-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this slack source.

Request body (application/json): SlackSourceRequest

Responses: 200 → SlackSource

PATCH /api/integrations/slack-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this slack source.

Request body (application/json): PatchedSlackSourceRequest

Responses: 200 → SlackSource

DELETE /api/integrations/slack-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this slack source.

Responses: 204

POST /api/integrations/slack-sources/{id}/send_test_message/

Send a test message to verify the integration.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this slack source.

Request body (application/json): SlackSourceRequest

Responses: 200 → SlackSource

POST /api/integrations/slack-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this slack source.

Request body (application/json): SlackSourceRequest

Responses: 200 → SlackSource


Snow instances

GET /api/snow-instances/

List snow instances

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
searchquerynostringA search term.

Responses: 200 → ServiceNowInstance[]

POST /api/snow-instances/

Create snow instance

Request body (application/json): ServiceNowInstanceRequest

Responses: 201 → ServiceNowInstance

GET /api/snow-instances/{id}/

Retrieve snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Responses: 200 → ServiceNowInstance

PUT /api/snow-instances/{id}/

Update snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Request body (application/json): ServiceNowInstanceRequest

Responses: 200 → ServiceNowInstance

PATCH /api/snow-instances/{id}/

Update snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Request body (application/json): PatchedServiceNowInstanceRequest

Responses: 200 → ServiceNowInstance

DELETE /api/snow-instances/{id}/

Delete snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Responses: 204

GET /api/snow-instances/{id}/change_templates/

Change templates: snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Responses: 200 → ServiceNowInstance

POST /api/snow-instances/{id}/set_default/

Set default: snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Request body (application/json): ServiceNowInstanceRequest

Responses: 200 → ServiceNowInstance

POST /api/snow-instances/{id}/start_cmdb_import/

Kick off a background pull of server CIs from this instance's CMDB.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Request body (application/json): ServiceNowInstanceRequest

Responses: 200 → ServiceNowInstance

POST /api/snow-instances/{id}/test_connection/

Test connection: snow instance

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this service now instance.

Request body (application/json): ServiceNowInstanceRequest

Responses: 200 → ServiceNowInstance


Thousandeyes sources

GET /api/integrations/thousandeyes-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
enabledquerynoboolean
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedThousandEyesSourceList

POST /api/integrations/thousandeyes-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): ThousandEyesSourceRequest

Responses: 201 → ThousandEyesSource

GET /api/integrations/thousandeyes-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Responses: 200 → ThousandEyesSource

PUT /api/integrations/thousandeyes-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Request body (application/json): ThousandEyesSourceRequest

Responses: 200 → ThousandEyesSource

PATCH /api/integrations/thousandeyes-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Request body (application/json): PatchedThousandEyesSourceRequest

Responses: 200 → ThousandEyesSource

DELETE /api/integrations/thousandeyes-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Responses: 204

GET /api/integrations/thousandeyes-sources/{id}/agents/

Return ThousandEyes agent list.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Responses: 200 → ThousandEyesSource

GET /api/integrations/thousandeyes-sources/{id}/alerts/

Return active ThousandEyes alerts.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Responses: 200 → ThousandEyesSource

POST /api/integrations/thousandeyes-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Request body (application/json): ThousandEyesSourceRequest

Responses: 200 → ThousandEyesSource

GET /api/integrations/thousandeyes-sources/{id}/tests/

Return the list of ThousandEyes tests for this account.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this thousand eyes source.

Responses: 200 → ThousandEyesSource


Vsphere sources

GET /api/integrations/vsphere-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedVSphereSourceList

POST /api/integrations/vsphere-sources/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): VSphereSourceRequest

Responses: 201 → VSphereSource

GET /api/integrations/vsphere-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Responses: 200 → VSphereSource

PUT /api/integrations/vsphere-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Request body (application/json): VSphereSourceRequest

Responses: 200 → VSphereSource

PATCH /api/integrations/vsphere-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Request body (application/json): PatchedVSphereSourceRequest

Responses: 200 → VSphereSource

DELETE /api/integrations/vsphere-sources/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Responses: 204

GET /api/integrations/vsphere-sources/{id}/inventory/

Fetch live inventory (VMs, clusters, datastores, etc.) for VM profile creation.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Responses: 200 → VSphereSource

POST /api/integrations/vsphere-sources/{id}/sync/

Pull VM + host inventory and cache counts in metadata.

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Request body (application/json): VSphereSourceRequest

Responses: 200 → VSphereSource

POST /api/integrations/vsphere-sources/{id}/test_connection/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere source.

Request body (application/json): VSphereSourceRequest

Responses: 200 → VSphereSource


Vsphere vm profiles

GET /api/integrations/vsphere-vm-profiles/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
orderingquerynostringWhich field to use when ordering the results.
pagequerynointegerA page number within the paginated result set.
page_sizequerynointegerNumber of results to return per page.
searchquerynostringA search term.

Responses: 200 → PaginatedVSphereVMProfileList

POST /api/integrations/vsphere-vm-profiles/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

Request body (application/json): VSphereVMProfileRequest

Responses: 201 → VSphereVMProfile

GET /api/integrations/vsphere-vm-profiles/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere vm profile.

Responses: 200 → VSphereVMProfile

PUT /api/integrations/vsphere-vm-profiles/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere vm profile.

Request body (application/json): VSphereVMProfileRequest

Responses: 200 → VSphereVMProfile

PATCH /api/integrations/vsphere-vm-profiles/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere vm profile.

Request body (application/json): PatchedVSphereVMProfileRequest

Responses: 200 → VSphereVMProfile

DELETE /api/integrations/vsphere-vm-profiles/{id}/

Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated

ParameterInRequiredTypeDescription
idpathyesintegerA unique integer value identifying this v sphere vm profile.

Responses: 204


Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.