Deployments

Get deployment

Returns the current state of a deployment.

Live status polling

For deployments with status queued, building, or deploying, the server queries the build worker in real time before responding. This means you always get the freshest status and build log with a single request — no separate logs endpoint needed during the build.

Expiry

The build worker marks a deployment expired when its TTL elapses and destroys the container. Subsequent polls of this endpoint reflect the expired status returned by the worker.

detected_env_vars

Once the build completes, detected_env_vars is populated with environment variable names that the build process referenced but that were not supplied. This helps diagnose previews that fail silently due to missing config.

hints (failed deployments only)

When status is failed, the response includes a top-level hints array alongside deployment. Each hint has an id, severity (error | warn | tip), title, and detail. Use these in CI pipelines to surface actionable guidance without parsing raw log output.

get/api/v1/deployments/{id}

Request

  • Base URL: https://previewdrop.dev
  • URL: https://previewdrop.dev/api/v1/deployments/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

UUID of the deployment.

Response

OK

Example response

{
  "deployment": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "tenant_id": "f0e1d2c3-b4a5-6789-0abc-def123456789",
    "project_id": "11223344-5566-7788-99aa-bbccddeeff00",
    "pd_projects": {
      "github_repo": "acme/my-app"
    },
    "worker_deploy_id": "abc123def456",
    "url": "https://prv-abc123.previews.previewdrop.dev",
    "status": "ready",
    "framework": "nextjs",
    "branch": "feat/new-checkout",
    "detected_env_vars": [
      "DATABASE_URL",
      "NEXT_PUBLIC_API_URL"
    ],
    "build_log": "[1/4] Installing dependencies...\n[2/4] Building application...",
    "expires_at": "2026-04-09T14:00:00.000Z",
    "created_at": "2026-04-09T10:00:00.000Z",
    "updated_at": "2026-04-09T10:03:42.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.