workflows.deployments

List Deployments

Changed on

List Deployments

get/v1/workflows/deployments

Request

Query parameters

active_onlyboolean
is_hardenedboolean nullable

Filter deployments by hardened status

workflow_namestring nullable
created_bystring nullable

Filter deployments by creator's user id

ownerstring nullable

Filter deployments by owner's user id

location_typesLocationType[] nullable

Filter deployments with at least one worker on any of these location types (OR)

searchstring nullable

Filter deployments by name or ID prefix

order_by'updated_at' | 'created_at' nullable

Field to sort by. When omitted, active and managed deployments are grouped first, then sorted by created_at. When set, results are sorted purely by the specified field with no grouping.

order'asc' | 'desc'

Sort direction. Applied to order_by when set, or within each activity group when omitted.

limitinteger nullable

Maximum number of deployments to return

cursorstring nullable

Cursor from a previous response for pagination

workspace_idstring uuid nullable

Workspace ID to scope the request to. Defaults to the caller's context.

Response

Successful Response

next_cursorstring nullable required

Cursor for the next page of results

workspace_idstring uuid required

Workspace ID the results are scoped to

Changes

    • warning

      deleted the query request parameter dockerfile_path

    • warning

      deleted the query request parameter repository_url

    • info

      added the new optional query request parameter dockerfile_path

    • info

      added the new optional query request parameter repository_url