Errors

Rebilly follow's the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.

Forbidden

Access forbidden.

Response Schema: application/json
type
string <uri>

A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

status
integer [ 400 .. 599 ]

The HTTP status code.

title
string

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail
string

A human-readable explanation specific to this occurrence of the problem.

error
string
Deprecated
property name*
any
Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

Conflict

Conflict.

Response Schema: application/json
type
string <uri>

A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

status
integer [ 400 .. 599 ]

The HTTP status code.

title
string

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail
string

A human-readable explanation specific to this occurrence of the problem.

error
string
Deprecated
property name*
any
Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

NotFound

Resource was not found.

Response Schema: application/json
type
string <uri>

A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

status
integer [ 400 .. 599 ]

The HTTP status code.

title
string

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail
string

A human-readable explanation specific to this occurrence of the problem.

error
string
Deprecated
property name*
any
Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

Unauthorized

Unauthorized access, invalid credentials was used.

Response Schema: application/json
type
string <uri>

A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

status
integer [ 400 .. 599 ]

The HTTP status code.

title
string

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail
string

A human-readable explanation specific to this occurrence of the problem.

error
string
Deprecated
property name*
any
Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

ValidationError

Invalid data was sent.

Response Schema: application/json
type
string <uri>

A URI reference [RFC3986] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".

status
integer [ 400 .. 599 ]

The HTTP status code.

title
string

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detail
string

A human-readable explanation specific to this occurrence of the problem.

error
string
Deprecated
invalidFields
Array of objects
property name*
any
Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string",
  • "invalidFields":
    [
    ]
}