Deployments

Trigger deployment

Queue a deployment of your documentation from the configured source (GitHub default branch or managed editor content). Returns a status ID you can poll with Get deployment status. Authenticate with a Velu API key.

POST/v1/update

Authorizations

BearerAuthorizationstringrequiredheader
Create a key in the dashboard under Settings → API keys. Send it as a Bearer token.

Response

202application/json

The update was queued.

status_idinteger
Poll Get deployment status with this ID.
statusenum<string>
Deployment status. Trigger deployment returns `queued`. Poll until `successful` or `failed`.
site_urlstring
subdomainstring
400application/json

Error response

error_codestring
messagestring
401application/json

Missing or invalid API key.

error_codestring
messagestring
404application/json

Error response

error_codestring
messagestring
503application/json

Error response

error_codestring
messagestring
Was this page helpful?
Powered byVelu