Responses
Unauthorized
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
detail |
Error details when a user has authenticated but lacks an OAuth scope to be able to perform the requested operation. |
|
DATA_TYPE |
string |
Type of this document. |
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"DATA_TYPE": "result#1.0.0",
"code": "not_authorized",
"message": "Missing or invalid authorization header."
}
UnprocessableEntity
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
DATA_TYPE |
string |
Type of this document. |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "unprocessable_entity",
"message": "Data Validation Error",
"detail": {
"DATA_TYPE": "invalid_input#1.0.0",
"errors": [
{
"message": "Missing data for required field.",
"property": "authentication_timeout_mins"
}
]
}
}
UnsupportedMedia
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
DATA_TYPE |
string |
Type of this document. |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "unsupported_media_type",
"message": "Request is in an invalid format"
}
ResourceConflict
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
detail |
Error details when the caller has attempted to update an object that results in a conflict with some other object. |
|
DATA_TYPE |
string |
Type of this document. |
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "conflict",
"message": "One or more storage gateways with this display_name already exist.",
"detail": {
"DATA_TYPE": "resource_conflict#1.0.0",
"resources": [
"2d99530d-3b20-44cb-94d3-61d8f85cd896"
]
}
}
Resource Exists
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
detail |
Error details when the caller has attempted to update an object that results in a conflict with some other object. |
|
DATA_TYPE |
string |
Type of this document. |
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"DATA_TYPE": "result#1.0.0",
"code": "exists",
"http_response_code": 409,
"message": "Node with ip address 192.168.2.3 already exists."
}
Conflict
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
DATA_TYPE |
string |
Type of this document. |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "conflict",
"message": "Storage Gateway cannot be deleted because it has existing collections.",
"DATA_TYPE": "result#1.0.0"
}
Not Found
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
DATA_TYPE |
string |
Type of this document. |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "not_found",
"message": "Storage Gateway \"cc268e71-6fee-4286-948a-ee89ec736db1\" does not exist.",
"DATA_TYPE": "result#1.0.0"
}
Missing required role
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
detail |
Error details when a user has authenticated but lacks a role to be able to perform the requested operation. |
|
DATA_TYPE |
string |
Type of this document. |
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "permission_denied",
"http_response_code": 403,
"detail": {
"DATA_TYPE": "missing_required_role#1.0.0",
"roles": [
{
"role": "administrator",
"collection": "18d367d5-45cf-4724-a53e-5a685e45c942"
}
]
},
"DATA_TYPE": "result#1.0.0",
"message": "Operation successful",
"data": [
{}
],
"has_next_page": false,
"marker": "string"
}
Permission Denied
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
DATA_TYPE |
string |
Type of this document. |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "permission_denied",
"message": "This operation requires an administrator role",
"DATA_TYPE": "result#1.0.0"
}
Subscription Required
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
HTTP response code |
detail |
Error details when the caller has attempted to access a feature not supported by the endpoint’s subscription. |
|
DATA_TYPE |
string |
Type of this document. |
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"DATA_TYPE": "result#1.0.0",
"code": "subscription_required",
"http_response_code": 403,
"message": "This feature requires a subscription.",
"detail": {
"DATA_TYPE": "subscription_required#1.0.0",
"subscription_level": "standard",
"add_ons": [
"Google Drive"
]
}
}
Bad request
Name |
Type |
Description |
code |
string |
Response code |
http_response_code |
|
|
DATA_TYPE |
string |
Type of this document. |
detail |
Machine readable response details |
|
message |
string |
Message describing this result. |
data |
array (object) |
|
has_next_page |
boolean |
Boolean flag indicating whether or not additional pages of response data may be requested by passing the marker to the same operation. |
marker |
string |
Opaque marker that may be passed to this API call to
fetch the next page of results if the returned document
has |
{
"code": "bad_request",
"message": "Bad request",
"DATA_TYPE": "result#1.0.0"
}