- URL:
- https://<root>/system/volumes/configurations
- Methods:
GET- Operations:
- Create Volume Configuration
- Version Introduced:
- 11.2
Access requirements
Required privileges
The ArcGIS Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the ArcGIS Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the ArcGIS Portal Directory API. For security reasons, all POST requests made to the ArcGIS Enterprise Administrator API must include a token in the request body.
Description
The configurations resource returns the name, ID, and volume type for PersistentVolumeClaim (PVC) volume templates. PVC volume templates allow for a GIS service's pods to create volumes on-demand, providing additional resources and improved performance for each pod.
This resource also provides access to the Create operation, which administrators can use to create PVC templates for ephemeral volumes.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the configurations resource:
https://organization.example.com/<context>/admin/system/volumes/configurations?f=pjsonJSON Response example
{
"volumeConfigurations": [
{
"name": "ephemeral-example",
"id": "om2zm3n55p3csil4r0vu6",
"type": "PVC_TEMPLATE"
}
],
"supportedOperations": []
}