Provisioning Service API

Auto-generated from NestJS controller decorators. Last synced: 2026-03-15

Base path: /api
Endpoints: 68

Provisioning Analytics

Get provisioning analytics and metrics

GET/provisioning/analyticsBearer token

Approvals

GET /approvals/pending

GET/approvals/pending

limitstring

query parameter

offsetstring

query parameter

GET /approvals/request/:provisioningRequestId

GET/approvals/request/:provisioningRequestId

provisioningRequestIdstringRequired

path parameter

POST /approvals/:provisioningRequestId/approve

POST/approvals/:provisioningRequestId/approve

provisioningRequestIdstringRequired

path parameter

Request Body: adminId: string; comment?: string;

adminIdstringRequired

—

commentstring

—

POST /approvals/:provisioningRequestId/reject

POST/approvals/:provisioningRequestId/reject

provisioningRequestIdstringRequired

path parameter

Request Body: adminId: string; comment?: string;

adminIdstringRequired

—

commentstring

—

GET /approvals/rules

GET/approvals/rules

POST /approvals/rules

POST/approvals/rules

Request Body: name: string; description?: string; condition: ApprovalCondition; tenantId?: string; priority?: number;

namestringRequired

—

descriptionstring

—

conditionApprovalConditionRequired

—

tenantIdstring

—

prioritynumber

—

PATCH /approvals/rules/:id

PATCH/approvals/rules/:id

idstringRequired

path parameter

Request Body: Partial name: string; description: string; condition: ApprovalCondition; tenantId: string; status: ApprovalRuleStatus; priority: number;

namestring

—

descriptionstring

—

conditionApprovalCondition

—

tenantIdstring

—

statusApprovalRuleStatus

—

prioritynumber

—

DELETE /approvals/rules/:id

DELETE/approvals/rules/:id

idstringRequired

path parameter

Clusters

List all infrastructure clusters

GET/clustersBearer token

typestring

query parameter

Get cluster by ID

GET/clusters/:idBearer token

idstringRequired

path parameter

Register a new infrastructure cluster

POST/clustersBearer token

Request Body: CreateClusterDto

namestringRequired

—

typeClusterTypeRequired

—

regionstringRequired

—

authUrlstring

—

apiUrlstring

—

projectNamestring

—

domainNamestring

—

credentialsRefstring

—

supportedResourceTypesstring[]

—

isDefaultboolean

—

provisioningEnabledboolean

—

capacityRecordstring, number

—

metadataRecordstring, unknown

—

Update cluster configuration

PATCH/clusters/:idBearer token

idstringRequired

path parameter

Request Body: UpdateClusterDto

namestring

—

regionstring

—

authUrlstring

—

apiUrlstring

—

projectNamestring

—

domainNamestring

—

credentialsRefstring

—

supportedResourceTypesstring[]

—

isDefaultboolean

—

provisioningEnabledboolean

—

capacityRecordstring, number

—

metadataRecordstring, unknown

—

Remove a cluster

DELETE/clusters/:idBearer token

idstringRequired

path parameter

Test connection to cluster infrastructure

POST/clusters/:id/test-connectionBearer token

idstringRequired

path parameter

DNS

List DNS zones for the current tenant

GET/dns/zones

tenantIdstringRequired

query parameter

Create a new DNS zone

POST/dns/zones

tenantIdstringRequired

query parameter

Request Body: CreateZoneDto

namestringRequired

—

typeDnsZoneType

—

dnssecEnabledboolean

—

Get DNS zone details

GET/dns/zones/:zoneId

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

Update DNS zone settings

PATCH/dns/zones/:zoneId

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

Request Body: UpdateZoneDto

dnssecEnabledboolean

—

Delete a DNS zone and all its records

DELETE/dns/zones/:zoneId

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

Verify NS delegation for the zone

POST/dns/zones/:zoneId/verify

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

Export zone in BIND format

GET/dns/zones/:zoneId/export

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

List records in a DNS zone

GET/dns/zones/:zoneId/records

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

typeDnsRecordType

query parameter

Create a DNS record

POST/dns/zones/:zoneId/records

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

Request Body: CreateRecordDto

namestringRequired

—

typeDnsRecordTypeRequired

—

contentstringRequired

—

ttlnumber

—

prioritynumber

—

disabledboolean

—

Bulk create/update/delete records

POST/dns/zones/:zoneId/records/bulk

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

Request Body: BulkRecordsDto

operationsBulkRecordOperation[]Required

—

Get a specific DNS record

GET/dns/zones/:zoneId/records/:recordId

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

recordIdstringRequired

path parameter

Update a DNS record

PATCH/dns/zones/:zoneId/records/:recordId

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

recordIdstringRequired

path parameter

Request Body: UpdateRecordDto

contentstring

—

ttlnumber

—

prioritynumber

—

disabledboolean

—

Delete a DNS record

DELETE/dns/zones/:zoneId/records/:recordId

tenantIdstringRequired

query parameter

zoneIdstringRequired

path parameter

recordIdstringRequired

path parameter

Set reverse DNS (PTR) for an IP

POST/dns/rdns

tenantIdstringRequired

query parameter

Request Body: ip: string; hostname: string;

ipstringRequired

—

hostnamestringRequired

—

Get reverse DNS for an IP

GET/dns/rdns/:ip

tenantIdstringRequired

query parameter

ipstringRequired

path parameter

Remove reverse DNS for an IP

DELETE/dns/rdns/:ip

tenantIdstringRequired

query parameter

ipstringRequired

path parameter

List all DNS zones across tenants (admin)

GET/dns/admin/zones

Get DNS statistics (admin)

GET/dns/admin/stats

List zone templates (admin)

GET/dns/admin/templates

Create a zone template (admin)

POST/dns/admin/templates

Request Body: name: string; description: string; records: name: string; type: string; content: string; ttl: number; priority?: number; [];

namestringRequired

—

descriptionstringRequired

—

recordsname: string; type: string; content: string; ttl: number; priority?: number; []Required

—

Delete a zone template (admin)

DELETE/dns/admin/templates/:templateId

templateIdstringRequired

path parameter

Health

Liveness probe

GET/health

Readiness probe

GET/ready

Provisioning

Create a new provisioning request

POST/provisioning/requestsBearer token

Request Body: CreateProvisioningRequestDto

tenantIdstringRequired

—

orderIdstringRequired

—

orderItemIdstringRequired

—

resourceTypeResourceTypeRequired

—

specificationResourceSpecificationDtoRequired

—

metadataRecordstring, unknown

—

Get provisioning statistics (counts by status and resource type)

GET/provisioning/statsBearer token

Get provisioning worker status (admin)

GET/provisioning/worker-statusBearer token

Check health of all registered cloud providers

GET/provisioning/providers/healthBearer token

List active service instances

GET/provisioning/instancesBearer token

statusstringRequired

query parameter

limitstring

query parameter

offsetstring

query parameter

List all provisioning requests (paginated)

GET/provisioning/requestsBearer token

limitstring

query parameter

offsetstring

query parameter

clusterIdstring

query parameter

Get real-time metrics for a service

GET/provisioning/requests/:id/metricsBearer token

idstringRequired

path parameter

Get audit trail for a provisioning request

GET/provisioning/requests/:id/auditBearer token

idstringRequired

path parameter

Get a provisioning request by ID

GET/provisioning/requests/:idBearer token

idstringRequired

path parameter

Get provisioning requests by order ID

GET/provisioning/requests/order/:orderIdBearer token

orderIdstringRequired

path parameter

Start provisioning a request

POST/provisioning/requests/:id/startBearer token

idstringRequired

path parameter

Advance to the next step

POST/provisioning/requests/:id/advanceBearer token

idstringRequired

path parameter

Request Body: AdvanceStepDto

outputRecordstring, unknown

—

Mark request as failed

POST/provisioning/requests/:id/failBearer token

idstringRequired

path parameter

Request Body: FailRequestDto

codestringRequired

—

messagestringRequired

—

Suspend (stop) a service

POST/provisioning/requests/:id/suspendBearer token

idstringRequired

path parameter

Reactivate (restart) a suspended service

POST/provisioning/requests/:id/reactivateBearer token

idstringRequired

path parameter

Complete a manual provisioning request with admin-provided access details

PATCH/provisioning/requests/:id/manual-completeBearer token

idstringRequired

path parameter

Request Body: ManualCompleteDto

ipAddressstring

—

hostnamestring

—

credentialsRecordstring, string

—

endpointsRecordstring, string

—

notesstring

—

Retry a failed provisioning request

POST/provisioning/requests/:id/retryBearer token

idstringRequired

path parameter

Delete (deprovision) a service

DELETE/provisioning/requests/:idBearer token

idstringRequired

path parameter

Quotas

GET /quotas

GET/quotas

tenantIdstring

query parameter

GET /quotas/:id

GET/quotas/:id

idstringRequired

path parameter

PUT /quotas/:tenantId/:resourceType

PUT/quotas/:tenantId/:resourceType

tenantIdstringRequired

path parameter

resourceTypeResourceTypeRequired

path parameter

Request Body: limits: QuotaLimits;

limitsQuotaLimitsRequired

—

DELETE /quotas/:id

DELETE/quotas/:id

idstringRequired

path parameter

GET /quotas/usage/:tenantId

GET/quotas/usage/:tenantId

tenantIdstringRequired

path parameter

Webhooks

Register a new webhook

POST/webhooksBearer token

Request Body: CreateWebhookDto

urlstringRequired

—

eventsProvisioningEventType[]Required

—

descriptionstring

—

headersRecordstring, string

—

metadataRecordstring, unknown

—

List all webhooks for tenant

GET/webhooksBearer token

Get webhook details

GET/webhooks/:idBearer token

idstringRequired

path parameter

Update webhook (optionally rotate secret)

PATCH/webhooks/:idBearer token

idstringRequired

path parameter

Request Body: UpdateWebhookDto

activeboolean

—

rotateSecretboolean

—

Delete a webhook

DELETE/webhooks/:idBearer token

idstringRequired

path parameter

Send a test delivery to this webhook

POST/webhooks/:id/testBearer token

idstringRequired

path parameter

List delivery history for a webhook

GET/webhooks/:id/deliveriesBearer token

idstringRequired

path parameter

queryQueryDeliveriesDtoRequired

query parameter