- URL:
- https://<root>/notebooks/workspaces/create
- Methods:
POST- Required Capability:
- Access allowed with the "Security and infrastructure" privilege
- Version Introduced:
- 11.4
Description
The create operation creates a notebook workspace for your organization. Only one notebook workspace is allowed for an organization. You can choose to use a Dynamic or Static persistent volume (PV) for the workspace. The PV for this workspace must be of type File and support the Read (RWX) access mode. Before configuring a notebook workspace, verify that the PV you allocated to this workspace supports RWX access mode. You may also need to install a supporting driver in your Kubernetes cluster to support the workspace's PV.
Request parameters
| Parameter | Details |
|---|---|
| Specify your own storage class name or if you've set a storage class, specify the storage class name for the volume. When binding to an existing PV that has no storage class defined, leave the storage class name blank. If a default storage class is configured in the cluster, the DefaultStorageClass admission controller adds the default storage class and prevents the PVC from binding. In this case, administrators should either add a storage class specification to the PV or remove the default storage class configuration. |
| Name of the storage volume. This is optional if the PV is dynamically provisioned. |
| Storage size allocated for the workspace in GiB. Only one notebook workspace can be configured for your organization. Its storage size is limited to the value specified at the time it was created. Ensure that you choose a sufficient size for the workspace to meet your current and future needs. |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the create operation:
POST /context/admin/notebooks/workspaces/create HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: [ ]
storageClassName=arcgis-storage-default&volumeName=&storage=1000&f=pjson&token=[token]The following is a sample POST request for the create operation:
POST /context/admin/notebooks/workspaces/create HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: [ ]
storageClassName=&volumeName=notebooksworkspace-pv-ar-123456789&storage=1000&&f=pjson&token=[token]JSON Response example
{"status": "success"}