- Notes, cautions, and warnings
- Additional resources
- Welcome
- REST API overview
- JSON request components
- JSON response components
- JSON encodings
- Preparing to make a request
- Querying a resource
- Retrieving data for multiple occurrences in a collection
- Retrieving data for a specified resource instance
- Omitting metadata from responses
- Specifying the attributes to return in a query response
- Paginating response data
- Filtering response data
- Sorting response data
- Aggregating response data
- Defining new attributes from existing attributes
- Extending queries to include related data
- Localizing response text
- Creating other types of requests
- Downloading and uploading files
- Downloading and uploading NAS server configuration files
- Downloading and uploading x.509 certificates
- Downloading configuration capture files
- Downloading service information files
- Downloading import session report files
- Downloading Data at Rest Encryption files
- Uploading upgrade candidates and language packs
- Uploading license files
- Perl example
Dell Unity™ Family Unisphere® Management REST API Programmer's Guide
URI patterns
In a REST API, the client sends Uniform Resource Identifiers (URIs) to the server. Each URI acts as a template for which you specify a resource type, ID, and desired action.
Basic URI patterns
The following table describes the basic URI patterns that the Unisphere Management REST API supports:
| URI pattern | HTTP Operations | Description |
|---|---|---|
| Collection type resource URI
/api/types/<resourceType>/instances |
GET | Retrieves a list of instances for the specified resource type.
For more information, see Retrieving data for multiple occurrences in a collection. |
| POST | Creates a new instance of the specified resource type, using data specified in the request body, if allowed.
For more information, see Creating a resource instance. |
|
| Instance resource URI
For all resource types: /api/instances/<resourceType>/<id> For applicable resource types: /api/instances/<resourceType>/name:<assignedName> |
GET | Retrieves the specified resource instance.
For more information, see Retrieving data for a specified resource instance. NOTE To see if a resource type can be identified by the user-assigned name, see the individual resource type topics in the
Unisphere Management API Reference Guide.
|
| DELETE | Deletes the specified resource instance, if allowed.
For more information, see Deleting a resource instance. NOTE To see if a resource type can be identified by the user-assigned name, see the individual resource type topics in the
Unisphere Management API Reference Guide.
|
|
| Instance action URI
For all resource types: /api/instances/<resourceType>/<id>/action/<actionName> For applicable resource types: /api/instances/<resourceType>/name:<assignedName>/action/<actionName> |
POST |
Performs the action specified in /action/<actionname> for the specified resource instance. For example, a URI pattern containing /action/modify directs the system to modify the specified resource instance. For more information, see Performing an instance-level resource-specific action. NOTE To see the supported actions for a resource type and whether the resource type can be identified by the user-assigned name, see the individual resource type topics in the
Unisphere Management API Reference Guide.
|
| Class-level action URI
/api/types/<resourceType>/action/<actionName> |
POST |
Performs the action specified in action/<actionName> for the specified non-singleton resource type. For example, a URI pattern containing action/RecommendForInterface for the ipPort resource type recommends ports on the SP specified in the body of the request to use for creating iSCSI NAS servers. For more information, see Performing a class-level resource-specific action. For a list of supported class-level actions for a resource type, see the individual resource type topics in the Unisphere Management API Reference Guide. |
URI patterns for downloading and uploading files
The following table describes the URI patterns for downloading and uploading files that the Unisphere Management REST API supports:
| URI pattern | HTTP Operations | Description |
|---|---|---|
| URI for downloading a NAS server configuration file
/download/<protocolType>/nasServer/<nasServerId> |
GET | Downloads a NAS server configuration file from the specified NAS server to the local host.
For more information, see Downloading and uploading NAS server configuration files. |
| URI for uploading a NAS server configuration file
/upload/<protocolType>/nasServer/<nasServerId> |
POST | Uploads a NAS server configuration file to the specified NAS server. You must
POST the NAS server configuration file using a multipart/form-data format, as if from a simple web page.
For more information, see Downloading and uploading NAS server configuration files. |
| URI for downloading an x.509 certificate file
/download/x509Certificate/<cert_id> |
GET | Downloads the specified x.509 certificate file from the storage system to the local host.
For more information, see Downloading and uploading x.509 certificates. |
| URI for uploading an x.509 certificate file
/upload/x509Certificate/ |
POST | Uploads an x.509 certificate from the local host to the storage system. You must
POST the x.509 certificate file using a multipart/form-data format, as if from a simple web page.
For more information, see Downloading and uploading x.509 certificates. |
| URI for downloading the keystore file for Data at Rest Encryption
/download/encryption/keystore |
GET | Downloads the keystore file for Data at Rest Encryption from the storage system to the local host.
For more information, see Downloading Data at Rest Encryption files. |
| URI for downloading the key manager audit logs and checksum files for Data at Rest Encryption
/download/encryption/auditLogAndChecksum?date=<YYYY-mm> |
GET | Downloads the key manager audit logs and checksum files together as a single .zip file from the storage system to the local host.
For more information, see Downloading Data at Rest Encryption files. |
| URI for downloading the checksum file for a specified key manager audit log
/download/encryption/checksum?audit_log=<audit_log_file_name>GET |
GET | Downloads the checksum file for a specified audit log from the storage system to the local host.
For more information, see Downloading Data at Rest Encryption files. |
| URI for uploading upgrade candidates and language pack files
/upload/files/types/candidateSoftwareVersion |
POST | Uploads an upgrade candidate or language pack file from the local host to the storage system. You must
POST the upgrade candidate or language pack file using a multipart/form-data format, as if from a simple web page.
For more information, see Uploading upgrade candidates and language packs. |
| URI for uploading license files
/upload/license |
POST | Uploads an upgrade candidate or language pack file from the local host to the storage system. You must
POST the upgrade candidate or language pack file using a multipart/form-data format, as if from a simple web page.
For more information, see Uploading license files. NOTE To install an uploaded license file, create a new instance of the license resource type.
|
Examples
- Retrieving all instances of the user resource type
-
GET /api/types/user/instances
- Retrieving user instance 001
-
GET /api/instances/user/001
- Creating a new user instance
-
POST /api/types/user/instances
- Deleting user instance 001
-
DELETE /api/instances/user/001
- Modifying user instance 001
-
POST /api/instances/user/001/action/modify
- Verifying connectivity from the storage server to the specified LDAP server (an instance-level action)
-
POST /api/instances/ldapServer/server1/action/verify
- Recommending Ethernet ports to use for creating link aggregations (a class-level action)
-
POST /api/types/ethernetPort/action/RecommendForAggregation
- Downloading the vasa_http-vc1-cacert-1 x.509 certificate file to the local host
-
GET /download/x509Certificate/vasa_http-vc1-cacert-1
- Uploading a license file to the storage system
-
POST /api/upload/license
Please provide ratings (1-5 stars).
Please provide ratings (1-5 stars).
Please provide ratings (1-5 stars).
Please select whether the article was helpful or not.
Comments cannot contain these special characters: <>()\