---
title: "Get Deployment"
method: GET
path: "/v1/workflows/deployments/{name}"
tags: ["workflows.deployments"]
---

# Get Deployment

`GET /v1/workflows/deployments/{name}`

Get Deployment

## Path parameters

- `name` string, required

## Query parameters

- `workflow_name` string, nullable — Scope serving status to this workflow

## Response `200`

Successful Response

- DeploymentDetailResponse
  - `id` string, uuid, required — Unique identifier of the deployment
  - `name` string, required — Deployment name
  - `is_active` boolean, required — Whether at least one worker is currently live
  - `is_hardened` boolean — Whether the deployment only accepts registrations from authorized principals
  - `created_at` string, date-time, required — When the deployment was first registered
  - `last_heartbeat` string, date-time, required — When the deployment last saw a worker registration
  - `updated_at` string, date-time, required — Deprecated alias of last_heartbeat
  - `owner` string, nullable — User id that owns the deployment, or null when it is administrator-managed
  - `location` DeploymentLocation
    - `location_type` 'local' | 'k8s' | 'managed', required
    - `k8s_cluster` string, nullable — K8s cluster name, if applicable
    - `k8s_namespace` string, nullable — K8s namespace, if applicable
  - `worker_count` integer — Number of workers registered to the deployment
  - `active_worker_count` integer — Number of workers currently live within the liveness cutoff
  - `locations` LocationType[] — Distinct location types reported by the deployment's workers
  - `managed` ManagedDeploymentResponse
    - `service_id` string, required
    - `name` string, required
    - `spec` DeploymentWorkerSpecResponse, required
      - `github_url` string, required
      - `type` string
      - `revision` string, nullable
      - `backend_spec` union, required — Backend-specific configuration. The arm's 'type' says where the worker runs: 'koyeb' or 'kubernetes'.
        - DeploymentK8sBackendSpec — Worker configuration for the Kubernetes backend.
          - `type` 'kubernetes'
          - `entrypoint` string, nullable — Either a 'module:function' reference (e.g. 'worker:main') or a '.py' script path relative to 'working_dir'.
          - `working_dir` string, nullable — Path in the repo holding the worker's pyproject.toml, for monorepo layouts. Leave empty for single-package repos.
        - DeploymentKoyebBackendSpec — Worker configuration for the Koyeb backend.
          - `type` 'koyeb'
          - `build_directory` string, nullable — Docker build context, as a path in the repo. Defaults to the repo root.
          - `dockerfile_path` string, nullable — Path to the Dockerfile, relative to 'build_directory'. Defaults to 'Dockerfile'.
          - `secrets` DeploymentSecretBinding[], nullable — Secrets to bind to the worker, as 'secret:workspace:<NAME>' references. Each is available during build and run: as a Dockerfile build arg (declare a matching 'ARG') and as an env var. On update, the field carries the complete set: send the full list to rebind, an empty list to unbind all, omit it to leave the bindings unchanged.
            - `env_var_name` string, required — Environment variable the worker process reads; the secret's name lives in 'reference'.
            - `reference` string, required — Secret reference as 'secret:workspace:<NAME>'. Resolved at boot by the runtime-init container; the value never reaches the control plane.
      - `restarted_at` string, nullable
      - `commit` GitCommitMetadata
        - `sha` string, required
        - `message` string, nullable
        - `author` GitCommitAuthor
          - `name` string, nullable
          - `username` string, nullable
          - `html_url` string, nullable
        - `html_url` string, nullable
      - `commit_sha` string, nullable, required
      - `entrypoint` string, nullable, required
      - `working_dir` string, nullable, required
    - `resources` DeploymentResourceConfig, required
      - `replicas` integer, nullable
      - `cpu_request` string, nullable
      - `cpu_limit` string, nullable
      - `memory_request` string, nullable
      - `memory_limit` string, nullable
    - `status` DeploymentObservedState, required
      - `phase` string, nullable
      - `available_replicas` integer
      - `ready_replicas` integer
      - `endpoint` string, nullable
      - `message` string, nullable
      - `last_seen` string, date-time, nullable
      - `deployed_revision` string, nullable
      - `generation` integer, nullable
      - `build_state` DeploymentBuildState
        - `phase` string, nullable
        - `commit_sha` string, nullable
        - `image` string, nullable
        - `message` string, nullable
        - `started_at` string, date-time, nullable
        - `finished_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `stopped` boolean
    - `rollout_status` string, nullable
    - `created_by` string, nullable
    - `updated_by` string, nullable
    - `deployed_by` string, nullable
    - `deployed_at` string, date-time, nullable
    - `is_hardened` boolean
    - `runtime_credential_id` string, uuid, nullable
    - `runtime_principal_type` 'api_key' | 'service_account' | 'user'
  - `workers` DeploymentWorkerResponse[], required — Workers registered for the deployment
    - `name` string, required — Worker name
    - `created_at` string, date-time, required — When the worker first registered
    - `last_heartbeat` string, date-time, required — When the worker last registered
    - `updated_at` string, date-time, required — Deprecated alias of last_heartbeat
    - `is_active` boolean, required — Whether this worker's liveness key is currently alive
    - `location` DeploymentLocation
      - `location_type` 'local' | 'k8s' | 'managed', required
      - `k8s_cluster` string, nullable — K8s cluster name, if applicable
      - `k8s_namespace` string, nullable — K8s namespace, if applicable

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-23** `fa73befe1c61` — 16 info
  - added the optional property `managed/anyOf[subschema #1: ManagedDeploymentResponse]/runtime_credential_id` to the response with the `200` status
  - added the optional property `managed/anyOf[subschema #1: ManagedDeploymentResponse]/runtime_principal_type` to the response with the `200` status
  - added the optional property `owner` to the response with the `200` status
  - the response optional property `managed/anyOf[subschema #1: ManagedDeploymentResponse]/spec/commit_sha` became read-only for the status `200`
  - …12 more
- **2026-08-14** `61436a496404` — 5 info
  - added the new optional `query` request parameter `workflow_name`
  - added the optional property `managed/anyOf[subschema #1: ManagedDeploymentResponse]/is_hardened` to the response with the `200` status
  - added the optional property `managed/anyOf[subschema #1: ManagedDeploymentResponse]/spec/commit` to the response with the `200` status
  - response property `location` deprecated
  - …1 more
- **2026-07-26** `933c4ebdcd72` — 1 warning, 5 info
  - added the new `managed` enum value to the `location/anyOf[subschema #1: DeploymentLocation]/location_type` response property for the response status `200`
  - added the optional property `active_worker_count` to the response with the `200` status
  - added the optional property `locations` to the response with the `200` status
  - added the optional property `managed` to the response with the `200` status
  - …2 more

[Change history](https://skmtc.dev/mistral/apis/mistral-ai-api/changes/v1/workflows/deployments/:name/get.md)

---

[API](https://skmtc.dev/mistral/apis/mistral-ai-api.md) · [All operations](https://skmtc.dev/mistral/apis/mistral-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mistral/apis/mistral-ai-api/revisions/fa73befe1c61?raw)