Docs
Search docs

Standard errors

These are the API's generic error bodies — the ones whose shape says nothing about the operation that returned them. They are described here once rather than repeated across 344 operation pages. An operation page lists the responses specific to it in full, and the ones below by status and description.

ErrorInternal344 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"corrupt_data""internal""manifest_tx_too_large""manifest_tx_too_long""manifest_unbounded_scan"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorTimeout344 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"timeout"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

RateLimitedBody344 of 344 operations

object

errorrequired

string

Always `rate_limited` — this body exists to carry the extra fields that kind needs.

"rate_limited"

retry_after_secondsrequired

integerint32

ErrorUnavailable342 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"unavailable"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorInvalidInput332 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"invalid_input"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorRateLimited318 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"rate_limited"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorForbidden294 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"forbidden"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorNotFound286 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"not_found"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorInvalidCredentialsOrUnauthenticatedOrUnauthorized213 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"invalid_credentials""unauthenticated""unauthorized"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorBusy127 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"busy"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflict54 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrNonFastForward39 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""non_fast_forward"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrGithubSyncActive22 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""github_sync_active"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorUpstream15 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"upstream"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorConflict12 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"conflict"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrGithubSyncActiveOrNonFastForward11 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""github_sync_active""non_fast_forward"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorInvalidOrExpired5 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"invalid_or_expired"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAttachPublishUnconfirmedOrConflictOrRelationshipConflictOrRelationshipUnavailable4 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"attach_publish_unconfirmed""conflict""relationship_conflict""relationship_unavailable"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorForbiddenOrGithubAppInstallRequired4 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"forbidden""github_app_install_required"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorForbiddenOrGithubAppLoginRequiredOrGithubAppPermissionMissingOrGithubIdentityRequiredOrNotAnOrgAdminOrOrgInstallationsUnsupported3 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"forbidden""github_app_login_required""github_app_permission_missing""github_identity_required""not_an_org_admin""org_installations_unsupported"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrAttachPublishUnconfirmedOrConflictOrGithubRefProofMismatchOrGithubSyncActiveOrNonFastForwardOrNotAnOrgInstallationOrRelationshipConflictOrRelationshipUnavailableOrReservedOnGithubOrTotpNotEnabled2 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""attach_publish_unconfirmed""conflict""github_ref_proof_mismatch""github_sync_active""non_fast_forward""not_an_org_installation""relationship_conflict""relationship_unavailable""reserved_on_github""totp_not_enabled"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrNotAnOrgInstallation2 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""not_an_org_installation"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorConflictOrGithubRefProofMismatch2 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"conflict""github_ref_proof_mismatch"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExists1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrNonFastForwardOrRelationshipConflict1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""non_fast_forward""relationship_conflict"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrRelationshipConflict1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""relationship_conflict"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrRelationshipConflictOrRelationshipUnavailable1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""relationship_conflict""relationship_unavailable"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorAlreadyExistsOrConflictOrReservedOnGithub1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"already_exists""conflict""reserved_on_github"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorConflictOrRelationshipConflictOrRelationshipUnavailable1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"conflict""relationship_conflict""relationship_unavailable"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorForbiddenOrGithubAppInstallRequiredOrGithubAppPermissionMissing1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"forbidden""github_app_install_required""github_app_permission_missing"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.

ErrorForbiddenOrGithubAppInstallRequiredOrGithubAppPermissionMissingOrGithubMirrorUnavailableForAppIdentity1 of 344 operations

object

errorrequired

string

Closed-set discriminant. Branch on this, not on the HTTP status.

"forbidden""github_app_install_required""github_app_permission_missing""github_mirror_unavailable_for_app_identity"

messagerequired

string

Human-readable detail. Not a stable contract — never parse it.