The following table describes the basic URI patterns that the PowerStore REST API supports:
URI pattern | HTTP Operations | Description |
---|---|---|
Collection type resource URI
/api/rest/<resource_type> |
GET | Retrieves a list of instances for the specified resource type. |
POST | Creates a new instance of the specified resource type, using data specified in the request body, if allowed. | |
Instance resource URI
/api/rest/<resource_type>/<id> |
GET | Retrieves the specified resource instance. |
PATCH | Modifies the specified resource instance, if allowed. | |
DELETE | Deletes the specified resource instance, if allowed. | |
Instance action URI
/api/rest/<resourceType>/<id>/<action> |
POST | Performs the operation specified by <action> for the specified resource instance. |
Class-level action URI
/api/rest/<resource_type>/<action> |
POST | Performs the operation specified by <action> for the specified non-singleton resource type. |
GET /api/rest/storage_container
GET api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31
POST /api/rest/storage_container
DELETE /api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31
PATCH /api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31
POST /api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31/mount
POST /api/rest/x509_certificate/exchange