prefix(string: "")- Specifies a string to filter deployments based on
an ID prefix. Because the value is decoded to bytes, the prefix must have an
even number of hexadecimal characters (0-9a-f) .This is specified as a query
string parameter and is used before any filter expression is applied.
namespace(string: "default") - Specifies the target namespace.
Specifying * will return all evaluations across all authorized namespaces.
This parameter is used before any filter expression is applied.
next_token(string: "") - This endpoint supports paging. The
next_token parameter accepts a string which is the ID field of
the next expected deployment. This value can be obtained from the
X-Nomad-NextToken header from the previous response.
per_page(int: 0) - Specifies a maximum number of deployments to
return for this request. If omitted, the response is not
paginated. The ID of the last deployment in the response can be
used as the last_token of the next request to fetch additional
pages.
filter(string: "") - Specifies the expression
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
reverse(bool: false) - Specifies the list of returned deployments should
be sorted in the reverse order. By default deployments are returned sorted in
chronological order (older deployments first), or in lexicographical order
by their ID if the prefix query parameter is used.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path.
This endpoint is used to mark a deployment as failed. This should be done to
force the scheduler to stop creating allocations as part of the deployment or to
cause a rollback to a previous job version. This endpoint only triggers a rollback
if the most recent stable version of the job has a different specification than
the job being reverted.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path and in the JSON payload.
Pause(bool: false) - Specifies whether to pause or resume the deployment.
This endpoint is used to promote task groups that have canaries for a
deployment. This should be done when the placed canaries are healthy and the
rolling upgrade of the remaining allocations should begin.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path and JSON payload.
All(bool: false) - Specifies whether all task groups should be promoted.
Groups(array<string>: nil) - Specifies a particular set of task groups
that should be promoted.
This endpoint is used to set the health of an allocation that is in the
deployment manually. In some use cases, automatic detection of allocation health
may not be desired. As such those task groups can be marked with an upgrade
policy that uses health_check = "manual". Those allocations must have their
health marked manually using this endpoint. Marking an allocation as healthy
will allow the rolling upgrade to proceed. Marking it as failed will cause the
deployment to fail. This endpoint only triggers a rollback if the most recent stable
version of the job has a different specification than the job being reverted.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path and the JSON payload.
HealthyAllocationIDs(array<string>: nil) - Specifies the set of
allocation that should be marked as healthy.
UnhealthyAllocationIDs(array<string>: nil) - Specifies the set of
allocation that should be marked as unhealthy.
This endpoint is used to manually mark a blocked multiregion deployment as
successful. A blocked deployment is a multiregion deployment within a region
that has completed within a region but is waiting on the other federated
regions. The endpoint can be used in cases where a failed peer region is
unable to communicate its failed deployment status to other regions to force a
deployment to complete.
:deployment_id(string: <required>)- Specifies the UUID of the deployment.
This must be the full UUID, not the short 8-character one. This is specified
as part of the path.
