Reference Guide

URI patterns
Basic URI patterns
The following table describes the basic URI patterns that the PowerStore Management REST API supports:
Table 1. Basic patterns in the REST API
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.
NOTE: URI parameters cannot contain slashes (/) or other special characters.
Examples
Retrieving all instances of the storage_container resource type
GET /api/rest/storage_container
Retrieving storage_container instance 70b37e07-b7fb-4e69-83ea-928680c4dc31
GET api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31
Creating a new storage container instance
POST /api/rest/storage_container
Deleting storage container instance 70b37e07-b7fb-4e69-83ea-928680c4dc31
DELETE /api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31
Modifying storage container instance 70b37e07-b7fb-4e69-83ea-928680c4dc31
PATCH /api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31
Mounting storage container instance 70b37e07-b7fb-4e69-83ea-928680c4dc31
POST /api/rest/storage_container/70b37e07-b7fb-4e69-83ea-928680c4dc31/mount
Exchanging SSL certificates with another PowerStore appliance
POST /api/rest/x509_certificate/exchange
REST request components
9