GIgitcafe
CI

Get a reported check run

Returns one check reported through the check-run API, with its annotations. Public repositories allow anonymous reads; supplied credentials are validated and may expand access to private resources.

get/api/repos/{owner}/{repo}/check-runs/{checkRunId}

Request

  • Base URL
    https://git.cafe
  • Auth
    • none
    • or 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:read

Path parameters

ownerstring required
repostring required
checkRunIdstring required

Response

Response for status 200

idstring required
keystring required
headOidstring required
namestring required
status'queued' | 'in_progress' | 'completed' required
conclusion'success' | 'failure' | 'neutral' | 'cancelled' | 'skipped' | 'timed_out' | 'action_required' | 'stale' | 'startup_failure' | 'null' nullable required
detailsUrlstring nullable required
externalIdstring nullable required
suitestring nullable required
startedAtstring date-time nullable required
completedAtstring date-time nullable required
rerequestableboolean required
rerequestedAtstring date-time nullable required
deadlineAtstring date-time nullable required
reporterIdstring required
installationIdstring nullable required
reportedAtstring date-time required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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