Specify operations to perform on resources in the HTTP method.
The REST API supports the following HTTP methods.
HTTP method |
Description |
---|---|
GET |
This method gets object information. Alternatively, this method gets a list of objects. For example, this method can obtain a list of pools. When information about multiple objects is obtained, the information is not sorted by object ID (id), such as the pool ID or volume ID. For this reason, filter the information to obtain by specifying query parameters. Alternatively, if you know the object IDs of the objects for which you want to get information, run the API request for obtaining information about specific objects. |
POST |
This method performs operations such as creating, adding, or expanding objects. For example, this method can create pools. |
PATCH |
This method partially changes the attributes or the state of an object. For example, this method can change the pool threshold. |
DELETE |
This method deletes objects. For example, this method can delete pools. |
The methods that can be used vary depending on the objects. For details, see the descriptions for each API function.