neosourceDocs
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 269 operation pages. An operation page lists the responses specific to it in full, and the ones below by status and description.

ErrorInternal269 of 269 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.

ErrorTimeout269 of 269 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.

RateLimitedBody269 of 269 operations

object

errorrequired

string

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

"rate_limited"

retry_after_secondsrequired

integerint32

ErrorUnavailable268 of 269 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.

ErrorInvalidInput258 of 269 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.

ErrorRateLimited250 of 269 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.

ErrorForbidden229 of 269 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.

ErrorNotFound218 of 269 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.

ErrorInvalidCredentialsOrUnauthenticatedOrUnauthorized168 of 269 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.

ErrorBusy95 of 269 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.

ErrorAlreadyExistsOrConflict52 of 269 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.

ErrorAlreadyExistsOrConflictOrNonFastForward29 of 269 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.

ErrorAlreadyExistsOrConflictOrGithubSyncActive16 of 269 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.

ErrorAlreadyExistsOrConflictOrGithubSyncActiveOrNonFastForward11 of 269 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.

ErrorConflict9 of 269 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.

ErrorUpstream7 of 269 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.

ErrorInvalidOrExpired3 of 269 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.

ErrorAlreadyExistsOrConflictOrGithubSyncActiveOrNonFastForwardOrRelationshipConflictOrRelationshipUnavailableOrReservedOnGithubOrTotpNotEnabled2 of 269 operations

object

errorrequired

string

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

"already_exists""conflict""github_sync_active""non_fast_forward""relationship_conflict""relationship_unavailable""reserved_on_github""totp_not_enabled"

messagerequired

string

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

ErrorAlreadyExists1 of 269 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.

ErrorAlreadyExistsOrConflictOrRelationshipUnavailable1 of 269 operations

object

errorrequired

string

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

"already_exists""conflict""relationship_unavailable"

messagerequired

string

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

ErrorAlreadyExistsOrConflictOrReservedOnGithub1 of 269 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 269 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.

ErrorForbiddenOrGithubIdentityRequiredOrOrgInstallationsUnsupported1 of 269 operations

object

errorrequired

string

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

"forbidden""github_identity_required""org_installations_unsupported"

messagerequired

string

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