Reference Guide

{
"id":"2d3cc48d-0296-4d15-afb9-252061cf7df9",
"severity":"Minor"
},
{
]
Using the is_async request parameter
The following asynchronous request deletes a local_user instance. The request returns the job ID:
Request
DELETE https://1.2.3.4/api/rest/local_user/4?is_async=true
Response
{
"id": "1ed0d49e-101b-4b8a-85dc-886f907e8070"
}
Related references
HTTP request headers on page 8
URI patterns on page 9
REST requests on page 12
REST requests
A JSON request body for the REST API consists of a collection of name:value pairs for a single resource type. The request body
has the following syntax:
● For number or boolean values:
{
<attributeName1>:<value1>,
<attributeName2>:<value2>,
.
.
.
}
● For IP, string, or datetime values:
{
<attributeName1>:"<value1>",
<attributeName2>:"<value2>",
.
.
.
}
For example, the request body for a create request for the local_user resource type could contain the following values:
{
"name": "user1",
"password": "myPassword"
"role_id": "operator"
}
Related references
HTTP request headers on page 8
URI patterns on page 9
Request parameters on page 10
12
REST request components