Skip to main content
POST
/
providers
/
{provider_id}
/
deploy
Deploy Provider
curl --request POST \
  --url https://api.example.com/providers/{provider_id}/deploy \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>"
}
'
{
  "status": "pending",
  "version": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "healthy": false
}

Path Parameters

provider_id
string
required

Body

application/json

Request to deploy a provider.

If version is omitted, deploys the latest successful build.

version
string | null

Response

Successful Response

User-facing provider deployment status.

Minimal representation without internal K8s details like replica counts, deployment names, or container images.

Attributes: status: Current deployment status. version: CalVer version string of deployed build. updated_at: Last update timestamp. healthy: Whether the provider is healthy (available with ready replicas).

status
enum<string>
required

Status of a provider deployment.

Available options:
pending,
progressing,
available,
failed
version
string | null
updated_at
string<date-time> | null
healthy
boolean
default:false