ci.environments.review

Approve or reject a job waiting at an environment

POST /ci/api/approvals/{approvalId}/reviewIAM ci:ReviewDeploymentsChanges state

Needs the IAM action AND a place on the environment’s reviewer list; with preventSelfReview, not the person who started the run. 409 when it was already decided.

Request syntax

POST /ci/api/approvals/{approvalId}/review
{
  "decision": "enum",
  "comment": "string"
}

Path parameters

  • approvalIdRequired

    string

    Constraints: uuid

Request body

  • decisionRequired

    enum

    approve: the job goes on (after any wait timer); reject: the job fails at its protection step

    One of: approve, reject

  • commentOptional

    string

    Kept with the decision and shown on the job, up to 2000 characters; blank: none

    Constraints: max 2000 chars

Response

200 with { id, status }: approved or rejected. 403 ("Forbidden: …") when the caller is not on the environment’s reviewer list or, with preventSelfReview, started the run; 409 when it was already decided or expired; 404 when the approval is not in this organization.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ci:ReviewDeployments on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ci environments review approvalId --decision approve

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ci_environments_review.