Provisioning
4 endpoints in this group. All paths are prefixed with /api/v1.
Endpoints in this group#
POST /api/v1/provisioning/callback— Provisioning CallbackGET /api/v1/provisioning/status/{service_slug}— Get Provisioning StatusGET /api/v1/provisioning/workflows— List WorkflowsGET /api/v1/provisioning/workflows/{workflow_id}— Get Workflow
POST /api/v1/provisioning/callback — Provisioning Callback {#post-api-v1-provisioning-callback}#
Handle an external service provisioning callback.
Services call this endpoint to report the result of an async provisioning operation. The callback_token identifies the workflow step that is waiting.
Body: ProvisioningCallbackRequest — {callback_token, status, endpoint, credentials + 2 more}
Responses:
200— Successful Response. Returns:ApiResponse_dict_— {data,meta}422— Validation Error. Returns:HTTPValidationError— {detail}
GET /api/v1/provisioning/status/{service_slug} — Get Provisioning Status {#get-api-v1-provisioning-status-service-slug}#
Get the provisioning status for a specific service.
Returns the most recent workflow for the service/tenant combination.
Parameters:
service_slug(path, string, required)authorization(header, string, optional)
Responses:
200— Successful Response. Returns:ApiResponse_ProvisioningStatusResponse_— {data,meta}422— Validation Error. Returns:HTTPValidationError— {detail}
GET /api/v1/provisioning/workflows — List Workflows {#get-api-v1-provisioning-workflows}#
List all provisioning workflows for the current tenant.
Parameters:
authorization(header, string, optional)
Responses:
200— Successful Response. Returns:ApiResponse_list_WorkflowResponse__— {data,meta}422— Validation Error. Returns:HTTPValidationError— {detail}
GET /api/v1/provisioning/workflows/{workflow_id} — Get Workflow {#get-api-v1-provisioning-workflows-workflow-id}#
Get workflow detail including steps.
Parameters:
workflow_id(path, string, required)authorization(header, string, optional)
Responses:
200— Successful Response. Returns:ApiResponse_WorkflowDetailResponse_— {data,meta}422— Validation Error. Returns:HTTPValidationError— {detail}