Reference Guide

Creating an asynchronous request
The following example uses the is_async=true request parameter on a request to modify an volume_group instance.
Headers
Accept: application/json
Content-Type: application/json
Authorization: <auth_cookie>
Request
PATCH https://1.2.3.4/api/rest/volume_group/e436abe3-d78e-4d1d-
a349-349368803c59?is_async=true
Request
body
{
"description": "Storage resources for the Finance department"
}
Response
body
{
"id": "1b6df699-7083-4440-912c-22e2ed89c530"
}
Viewing an asynchronous request
The following example shows the job instance that is associated with the request that is shown above:
Headers
Accept: application/json
Content-Type: application/json
Authorization: <auth_cookie>
Request
GET https://1.2.3.4/api/rest/job/1b6df699-7083-4440-912c-22e2ed89c530?
select=id,description_l10n,state,response_body
Request
body
Empty.
Response
body
{
"id": "1b6df699-7083-4440-912c-22e2ed89c530",
"description_l10n": "Modify a volume group.",
"state": "COMPLETED",
"response_body": null
}
42 Creating other types of requests