Errors

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
`bad-request`	The request is not valid.
`conflict`	The requested operation could not be performed because of a conflict with an existing resource.
`cpcode-creation-failed`	There is a problem creating a CP code for the sandbox. Specify the CP code to use with the sandbox.
`cpcode-not-found`	CP code does not exist.
`duplicate-name`	The requested operation could not be performed because the name you specified already exists.
`duplicate-property`	The requested operation could not be performed because more than one property was found.
`edgeworker-tarball-validation-failed`	There is a problem with validating the tarball file.
`error`	An unexpected error has occurred.
`forbidden`	You don’t have permission to access this resource.
`hostname-conflict`	The requested operation could not be performed because of a conflict with an existing property hostname.
`invalid-create-from-property`	The `createFromProperty` request is not valid.
`invalid-argument`	The argument is not valid.
`invalid-create-request`	The create sandbox request is not valid.
`invalid-request-hostname`	The request hostname is not valid.
`invalid-rule-tree-behavior`	The rule tree behavior is not valid.
`invalid-parameter`	One or more parameters are invalid.
`message-not-readable`	The input object contains invalid JSON.
`method-not-allowed`	The specified method is not allowed for this endpoint.
`metadata-validation-error`	There is a problem with validating the property configuration.
`not-authorized`	You are not authorized to access this service.
`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.
`request-hostnames-empty`	The request hostnames must not be empty.
`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.