---
title: "Get deployment"
method: POST
path: "/v2/deploy.getDeployment"
tags: ["deploy"]
---

# Get deployment

`POST /v2/deploy.getDeployment`

**INTERNAL** - This endpoint is internal and may change without notice.
Not recommended for production use.

Retrieves deployment information including status, error messages, and steps.

**Authentication**: Requires a valid root key with appropriate permissions.

## Request body

- V2DeployGetDeploymentRequestBody
  - `deploymentId` string, required — Unique deployment identifier to retrieve

## Response `200`

Deployment retrieved successfully

- V2DeployGetDeploymentResponseBody
  - `meta` Meta, required — Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
    - `requestId` string, required — A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.
  - `data` V2DeployGetDeploymentResponseData, required
    - `id` string, required — Unique deployment identifier
    - `status` 'UNSPECIFIED' | 'PENDING' | 'BUILDING' | 'DEPLOYING' | 'NETWORK' | 'READY' | 'FAILED', required — Current deployment status
    - `errorMessage` string — Error message if deployment failed
    - `hostnames` string[] — Hostnames associated with this deployment
    - `steps` V2DeployDeploymentStep[] — Deployment steps with status and messages
      - `status` string — Step status
      - `message` string — Step message
      - `errorMessage` string — Error message if step failed
      - `createdAt` integer — Unix timestamp in milliseconds

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `429` — Too Many Requests
- `500` — Internal server error

## Changes

- **2026-02-27** `551df53dd45d` — 1 info
  - added the non-success response with the status `429`
- **2026-01-19** `68faf8570845` — 1 info
  - added the non-success response with the status `403`
- **2026-01-15** `99a38ad36f8b` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/unkeyed/apis/unkey-api/changes/v2/deploy.getDeployment/post.md)

---

[API](https://skmtc.dev/unkeyed/apis/unkey-api.md) · [All operations](https://skmtc.dev/unkeyed/apis/unkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/unkeyed/unkey-api/revisions/551df53dd45d/schema)