GIgitcafe
CI

Report a check run

Creates or replaces the caller's check with this key on the exact commit OID. The key is the check's identity for its reporter (the app installation, or the token's account); the name is what branch protection requires. A write whose reportedAt is older than the stored one, or than an unanswered re-run request, is ignored: read outcome. At most 50 annotations; a write replaces them all. Requires authenticated authority and enforces current resource policy.

put/api/repos/{owner}/{repo}/commits/{hash}/check-runs/{key}

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: repo:checks:write

Path parameters

ownerstring required
repostring required
hashstring required
keystring required

Request body

namestring required
status'queued' | 'in_progress' | 'completed' required
conclusion'success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required'
detailsUrlstring uri
externalIdstring
suitestring
startedAtstring date-time
completedAtstring date-time
rerequestableboolean
timeoutMinutesinteger
reportedAtstring date-time

Response

Response for status 200

outcome'created' | 'updated' | 'unchanged' | 'ignored_stale' required

Changes

No recorded changes to this operation across all 1 revision of this API.