workflows.deployments

Get Deployment

get/v1/workflows/deployments/{name}

Request

Path parameters

namestring required

Query parameters

workflow_namestring nullable

Scope serving status to this workflow

Response

Successful Response

idstring uuid required

Unique identifier of the deployment

namestring required

Deployment name

is_activeboolean required

Whether at least one worker is currently live

is_hardenedboolean

Whether the deployment only accepts registrations from authorized principals

created_atstring date-time required

When the deployment was first registered

last_heartbeatstring date-time required

When the deployment last saw a worker registration

updated_atstring date-time required

Deprecated alias of last_heartbeat

ownerstring nullable

User id that owns the deployment, or null when it is administrator-managed

worker_countinteger

Number of workers registered to the deployment

active_worker_countinteger

Number of workers currently live within the liveness cutoff

locationsLocationType[]

Distinct location types reported by the deployment's workers

Changes

    • breaking

      added to the /// response property oneOf list for the response status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added mistral_cloud discriminator mapping keys to the /// response property for the response status

    • info

      mapped value for discriminator key koyeb changed from to for /// response property for the response status

    • info

      removed from the /// response property oneOf list for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response optional property /// became read-only for the status

    • info

      the response optional property /// became read-only for the status

    • info

      the response optional property /// became read-only for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      response property managed/anyOf[subschema #1: ManagedDeploymentResponse]/spec/entrypoint deprecated

    • info

      response property managed/anyOf[subschema #1: ManagedDeploymentResponse]/spec/working_dir deprecated

    • info

      response property updated_at deprecated

    • info

      response property workers/items/updated_at deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status