NSX-T Data Center REST API

301 - Moved Permanently

Request must be reissued to a different controller node.

The controller node has been replaced by a new node that should be used for this and all future requests.

Response Code 301 Moved Permanently
Response Headers Content-Type: text/plain
Location: <URI for new request>
Response Body Additional information about the error, if available.

307 - Temporary Redirect

Request should be reissued to a different controller node.

The controller node is requesting the client make further requests against the controller node specified in the Location header. Clients should continue to use the new server until directed otherwise by the new controller node.

Response Code 307 Temporary Redirect
Response Headers Content-Type: text/plain
Location: <URI for new request>
Response Body Additional information about the error, if available.

400 - Bad Request

Request was improperly formatted or contained an invalid parameter.

Response Code 400 Bad Request
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

403 - Forbidden

The client does not have sufficient privileges to execute the request.

The API is likely in read-only mode, or a request was made to modify a read-only property.

Response Code 403 Forbidden
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

404 - Not Found

An entity referenced in the request does not exist.

Create the referenced resource first, then reissue the request.

Response Code 404 Not Found
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

405 - Method Not Allowed

The provided REST method is not allowed or does not exist.

Response Code 405 Method Not Allowed
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

409 - Conflict

The request can not be performed because it conflicts with configuration on a different entity, or because another client modified the same entity.

If the conflict arose because of a conflict with a different entity, modify the conflicting configuration. If the problem is due to a concurrent update, re-fetch the resource, apply the desired update, and reissue the request.

Response Code 409 Conflict
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

412 - Precondition Failed

The request can not be performed because a precondition check failed. Usually, this means that the client sent a PUT or PATCH request with an out-of-date _revision property, probably because some other client has modified the entity since it was retrieved. The client should re-fetch the entry, apply any desired changes, and re-submit the operation.

Response Code 412 Precondition Failed
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

415 - Unsupported Media Type

The requested media type is not supported.

Check the Accept: header sent by the client. In most cases, application/json is the correct value to send.

Response Code 415 Unsupported Media Type
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

428 -

Precondition required.

In most cases, this error is returned when the caller does not provide the correct _revision property in a PUT request. Clients should retrieve the resource using the GET method, and then use the value of the _revision property in the PUT request.

Response Code 428
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

429 -

Too many requests.

The client has exceeded the maximum number of API requests per second. The client should wait before sending additional API requests.

Response Code 429
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

500 - Internal Server Error

An internal error occurred while executing the request. If the problem persists, perform diagnostic system tests, or contact your support representative.

Response Code 500 Internal Server Error
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.

503 - Service Unavailable

The request can not be performed because the associatedresource could not be reached or is temporarily busy. Verify theassociated resource is connected, then reissue the request.

Response Code 503 Service Unavailable
Response Headers Content-Type: text/plain
Response Body Additional information about the error, if available.