git.commit-statuses.create

Report a status on a commit (one per context; a later one replaces it)

POST /git/api/repositories/{repoId}/commits/{sha}/statusesIAM git:CreateCommitStatusChanges state

GitHub’s POST /repos/{owner}/{repo}/statuses/{sha}. A branch protection rule whose required checks name this context waits for it: pending waits, success passes, failure and error block.

Request syntax

POST /git/api/repositories/{repoId}/commits/{sha}/statuses
{
  "state": "enum",
  "context": "string",
  "description": "string",
  "targetUrl": "string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • shaRequired

    string

    Constraints: /^[0-9a-f]{40}$/

Request body

  • stateRequired

    enum

    The result: pending waits, success passes, failure and error block a required check

    One of: pending, success, failure, error

  • contextOptional

    string

    Names the check; a required check of this name gates merges

    Constraints: 1-255 chars

    Default: "default"

  • descriptionOptional

    string

    A short summary shown beside the status

    Constraints: max 1000 chars

  • targetUrlOptional

    string

    An https:// link to the details

    Constraints: max 2000 chars

Response

201 with the status as stored now for this context, as `list` shows it.

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

Fields of data

  • idAlways

    string

    The status's id
  • orgIdAlways

    string

    Your organization
  • repoIdAlways

    string

    The repository the record belongs to
  • commitOidAlways

    string

    The commit the status is reported on
  • contextAlways

    string

    The name of the check; one status per context and commit
  • stateAlways

    one of pending, success, failure, error

    The result: pending waits, success passes, failure and error block
  • descriptionAlways

    string, may be null

    A short summary; null when none was given
  • targetUrlAlways

    string, may be null

    A link to the details; null when none was given
  • creatorIamUserIdAlways

    string, may be null

    The IAM user who reported it; null when that user has been deleted
  • createdAtAlways

    string

    When the context was first reported on this commit (ISO 8601)
  • updatedAtAlways

    string

    When it was last reported (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:CreateCommitStatus 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 commit-statuses create repoId sha --state pending

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