Reference Guide

If the request does not succeed, the server returns a 4xx or 5xx HTTP status code in the response header and a message entity
in the response body.
Exchanging SSL certificates
The following request exchanges SSL certificates with another PowerStore appliance:
Headers
Accept: application/json
Content-Type: application/json
Authorization: <auth_cookie>
Request
POST /api/rest/x509_certificate/exchange
Request
body
{
"service": "Management_HTTP",
"address": "10.244.53.108",
"port": 8080,
"username": "user1",
"password": "myPassword"
}
Response
body
Empty.
Working with asynchronous requests
By default, all REST API requests are synchronous, which means that the client/server connection stays open until the request
completes and the response is returned.
Alternatively, you can make any active management request (one that changes the system rather than just querying it) into an
asynchronous request by adding URL parameter is_async=true to the request URL. Asynchronous requests can be more
reliable than synchronous requests. With an asynchronous request, you start a job, and the server returns an associated job
resource instance almost immediately. You can query the job resource instance when convenient to get the HTTP response
code and response body for the request. If you create a synchronous request and the network connection is lost, or the REST
client or server goes down while the request is processing, there is no way to obtain the request status when it does eventually
complete.
Syntax
As the first parameter on the request URI:
?is_async=true
As a subsequent parameter on the request URI:
&is_async=true
Usage
The following considerations apply to asynchronous requests:
● A valid asynchronous request returns a 202 Accepted HTTP status code and a minimal job resource instance in the
response body.
● An invalid asynchronous request returns immediately with the appropriate error code in the response header and a message
entity in the response body.
To view the status of an asynchronous request, retrieve data for the appropriate job resource instance. For example, if an
asynchronous PATCH local_user user request returns a job resource instance with an id of
1b6df699-7083-4440-912c-22e2ed89c530, you can use an instance query to retrieve the asynchronous request data
from this job resource. Query at least the state and response_body attributes. If the state is Completed or Failed,
the response_body contains the error response.
Creating other types of requests
41