git.labels.update

Rename, recolour or describe a label

PATCH /git/api/repositories/{repoId}/labels/{labelId}IAM git:ManageLabelsChanges state

Request syntax

PATCH /git/api/repositories/{repoId}/labels/{labelId}
{
  "name": "string",
  "color": "string",
  "description": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • labelIdRequired

    string

    Constraints: uuid

Request body

  • nameOptional

    string

    The new name

    Constraints: 1-50 chars

  • colorOptional

    string

    The new colour: six hex digits, e.g. d73a4a

  • descriptionOptional

    string

    The new description; null removes it

    Constraints: max 200 chars

    May be null.

Response

200 with the label after the change. 404 also when the new name is taken.

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

Fields of data

  • idAlways

    string

    The label id
  • orgIdAlways

    string

    The organization it belongs to
  • repoIdAlways

    string

    The repository it belongs to
  • nameAlways

    string

    The label name, unique within the repository
  • colorAlways

    string

    Six hex digits, without #
  • descriptionAlways

    string, may be null

    What the label means; null when none was given
  • createdAtAlways

    string

    When it was created (ISO 8601)

Checked against the handlers: every route test validates their answers against this schema.

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 git:ManageLabels 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 git labels update repoId labelId

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