After receiving a request to the intended API, Cloud Email and Collaboration
Protection returns a response indicating whether the request was
successful.
The response is in the JSON format and subject to the HTTP response status
codes.
The following table outlines the supported HTTP response status codes:
|
Response Status
|
Status Code
|
Description
|
|
OK
|
200
|
The request has been successfully executed, or at least one record matching
the criteria in the request was found and returned in the response body.
In the case of a JSON format, the structure is always returned, even if empty.
|
|
Created
|
201
|
The request has been handled and the action is created successfully.
|
|
Bad Request
|
400
|
The request is missing a mandatory parameter, or a parameter contains data
that is incorrectly formatted.
|
|
Unauthorized
|
401
|
There is no authorization information included in the request, the
authorization information is incorrect, or the user is not authorized.
|
|
Forbidden
|
403
|
There is no permission for the request.
|
|
Not Found
|
404
|
The requested API or task token could not be found.
|
|
Method Not Allowed
|
405
|
The requested method is not supported for the requested API.
|
|
Too Many Requests
|
429
|
The user has made more than 20 requests over the past 1 minute and has been
throttled.
The user can start new requests in the next minute from the first request.
|
|
Internal Server Error
|
500
|
The service has encountered an unexpected situation and is unable to give a
better response to the request.
|
|
Service Unavailable
|
503
|
The server cannot handle the request (because it is overloaded or down for
maintenance). Generally, this is a temporary state.
|
For a status code other than 200, each error response has a formatted body that
consists of a result code, a trace ID, and a message as follows:
HTTP/1.1 <status code> <response status>
Content-Type: application/json
{
"code":(an integer indicating the result of this API call),
"traceId":"(randomly generated identity to uniquely trace the request)",
"msg":"(a string describing the result code)"
}
 |
NoteFor a complete list of
code values, see API result codes. |