deployments

Retrieve a Deployment

Changed on

Retrieves a deployment. Its routes carry the effective state as of it — the newest route per (resource template, environment) key at or before the deployment — including routes written by earlier deployments. This endpoint requires a production API key; sandbox API keys receive 401.

get/deployments/{deployment-id}

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/deployments/{deployment-id}
  • Auth: HTTP bearer

Path parameters

deployment-idstring required

Query parameters

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns a Deployment object.

Changes