External Volume

List external volumes¶

GET/api/v2/external-volumes
List external volumes

Query Parameters¶

ParameterDescription
like string
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.

Create an external volume¶

POST/api/v2/external-volumes
Create an external volume

Query Parameters¶

ParameterDescription
createMode string
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Response¶

CodeDescription
200
Successful request.
202

Fetch an external volume¶

GET/api/v2/external-volumes/{name}
Fetch an external volume

Path Parameters¶

ParameterDescription
name string
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
202

Delete an external volume¶

DELETE/api/v2/external-volumes/{name}
Delete an external volume

Query Parameters¶

ParameterDescription
ifExists boolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202

Undrop an external volume¶

POST/api/v2/external-volumes/{name}:undrop
Undrop an external volume

Response¶

CodeDescription
200
202
Language: English