This section provides details on the API's common response to error cases, and lists the API's range of response status codes for both error and success cases.
Error responses
If an error occurs, this API responds with JSON objects that provide information you can use to debug the problem. For example:
{
"type": "/sandbox-api/error-types/property-manager-search-failed",
"title": "We were unable to find the specified Property.",
"detail": "No match found for search 'PropertyId=123'",
"instance": "/sandbox-api/error-instances/d26808a4-fd0f-411c-801f-ab20ee4f455a",
"status": 400,
}
For details on information contained in the error responses, refer to Error response syntax.
Error types
The API returns error messages that follow this URL pattern /sandbox-api/error-types/{error}
.
Error | Description |
---|---|
duplicate-property | The requested operation could not be performed because multiple properties were found. |
invalid-create-from-property | Invalid createFromProperty request. |
invalid-create-request | Invalid create sandbox request. |
invalid-request-hostname | The request hostname is not valid. |
invalid-rule-tree-behavior | The rule tree behavior is not valid. |
message-not-readable | The input object contains invalid JSON. |
method-not-allowed | The specified method is not allowed on this endpoint. |
metadata-validation-error | There was a problem related to validating the property configuration. |
not-found | The resource cannot be found. |
not-clonable | The sandbox resource cannot be cloned. |
property-manager-api-error | There is a problem related to the Property Manager API. |
property-manager-search-failed | The property cannot be found. |
property-manager-api-validation-error | The Property Manager API rule tree could not be validated. |
quota-limit-exceeded | The requested operation cannot be performed because it exceeds the quota limit. |
unsupported-media-type | The specified media type is not supported. |
upgrade-failed | The sandbox cannot be upgraded because it is not associated with a property. Follow the instructions to Create a sandbox. |
HTTP status codes
This section lists the full range of response codes the API generates.
Code | Description |
---|---|
200 | The operation was successful. |
201 | The resource was created. |
204 | The request was successfully processed. |
400 | Bad Request. |
403 | Access is forbidden. |
404 | The resource was not found. |
405 | The method is not allowed. |
409 | Conflict with current state of resource. |
415 | Unsupported media type. |
500 | Internal server error. |