REST API response codes
The Lenovo XClarity Administrator REST APIs use the HTTP protocol for sending and retrieving data. Client code using the REST APIs makes an HTTP request to the Lenovo XClarity Administrator server and processes the HTTP response accordingly. Included with the HTTP response data is the HTTP response code. The response code provides some indication as to the success of the HTTP request and can provide information on how to handle the included response data.
The following table lists some of the most common response codes.
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 201 | Created | One or more new resources were successfully created. |
| 202 | Accepted | The request has been accepted for processing, but the processing has not yet completed. The request might or might not be acted upon, depending on the results of the processing. |
| 203 | Found | The URL changed. The response header returns the correct URL in the Location field. |
| 204 | No Content | The request completed successfully, but no response content is returned. |
| 206 | Partial Content | The part, but not all, of the request completed successfully. |
| 307 | Temporary Redirect | The URL changed for this REST API. The response header returns the correct URL in the Location attribute. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 401 | Unauthorized | The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions. |
| 404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
| 405 | Method Not Allowed | A specified resource is invalid. A descriptive error message is returned in the response body. |
| 406 | Not Supported | A specified resource is not supported or not available for connection. A descriptive error message is returned in the response body. |
| 408 | Request Timeout | The orchestrator server did not receive a required request in a specific amount of time. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 412 | Precondition failed | Specified data is invalid because of missing values. A descriptive error message is returned in the response body. |
| 413 | Request Entity Too Large | Clients might impose limitations on the length of the request URI, and the request URI is too long to be handled. A descriptive error message is returned in the response body. |
| 423 | Locked | The source or target resource is locked. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
| 503 | Service Unavailable | The server is not ready to handle the request. |
Give documentation feedback