Get deployment
Retrieve a single deployment by its id.
Use this to check a deployment’s status after creating it, or to inspect the runtime configuration of an existing deployment.
Required Permissions
Your root key must have one of the following permissions:
environment.*.read_deployment(to read deployments in any environment)environment.<environment_id>.read_deployment(to read deployments in a specific environment)
Authorizations
Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:
Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:
- Keep root keys secure and never expose them in client-side code
- Use different root keys for different environments
- Rotate keys periodically, especially after team member departures
- Create keys with minimal necessary permissions following least privilege principle
- Monitor key usage with audit logs.
Body
Retrieve a single deployment, including its status and runtime configuration.
Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
3 - 255^[a-zA-Z0-9_-]+$"proj_1234abcd"
Response
Successfully retrieved the deployment.