Format of API function

Note

This manual uses a curl command example in Linux to explain how to call a REST API function. If you call a REST API function in Windows, follow the specifications of Windows. For details about curl command, see the website of the following URL.

https://curl.haxx.se/

The format to call a REST API function by using a curl command is as follows.

Note that the part of the variable characters in format is described by using italics characters like the following example:

Example: http://HOSTNAME:PORTNUMBER/api/v1/agents/agentId

Format of a curl command for calling a REST API function
curl -X {POST|GET|PUT|DELETE} --header 'REQUESTHEADER' 　[-d 'REQUESTBODYINJSONFORMAT']  [--form 'file=@FILENAME']  'PATHOFRESTAPI'
Request header

The type of request header is as follows:

Header Type Description Value

Content-Type:

This is a header that specifies a MIME type for a request.

Specify this header when you use a POST method or a PUT method.

 application/json

Accept:

This is a header that specifies an acceptable MIME type to receive a response.

 application/json

X-API-KEY:

This is a header that specifies an API key.

Except for the Acquire an API key API and the Reacquire an API Key API, specify this key when you call an API.

 Specify the key that is acquired by using the Acquire an API key API.