ci.variables.put

Create or change a repository variable

PUT /ci/api/repositories/{repoId}/variables/{variable}IAM ci:PutVariableChanges state

Request syntax

PUT /ci/api/repositories/{repoId}/variables/{variable}
{
  "value": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • variableRequired

    string

    Constraints: /^[A-Za-z_][A-Za-z0-9_]*$/

Request body

  • valueRequired

    string

    Plain text, never secret (shown in the console, not masked in logs); up to 48 KiB

    Constraints: max 49152 chars

Response

200, whether it created the variable or changed it, with { name, value, updatedAt }; the name is stored upper-case. 400 when the name breaks the rule or starts with GITHUB_, or the body is not { value: string }. 404 when the repository 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:PutVariable 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 variables put repoId variable --value example

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