Get deployment

Returns the full Deployment record including current status and the live URL.

GET /v1/deployments/{id}

Get deployment

cURL

curl --request GET \
  --url https://api.vly.ai/v1/deployments/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "dpl_01JFA8N3Z1B6Y2K7Q3X4M5R8",
  "project_id": "<string>",
  "environment": "preview",
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

status is one of: queued, building, ready, failed. When ready, the url field contains the live URL.

For a stream of status updates without polling, use a webhook subscribed to deployment.* events.

Authorizations

Authorization · string · header · required

Workspace-scoped API key. Generate from Workspace settings → API keys.

Path Parameters

id · string · required

Response

200 - application/json

OK

id · string · required

Example:

"dpl_01JFA8N3Z1B6Y2K7Q3X4M5R8"

project_id · string · required

environment · enum<string> · required

Available options: preview, production

status · enum<string> · required

Available options: queued, building, ready, failed

created_at · string<date-time> · required

url · string<uri> | null