Endpoint Groups

Volumes

Volumes operations within the Catalogs API group.

List volumesGET

/catalogs/{catalogName}/schemas/{schemaName}/volumes

Operation IDlistVolumes

Name	Type	Required	Description
`catalogName`	`string`	`true`	-
`schemaName`	`string`	`true`	-

Name	Type	Required	Description
`max_results`	`integer`	`false`	-
`page_token`	`string`	`false`	-

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

/catalogs/{catalogName}/schemas/{schemaName}/volumes

Operation IDcreateVolume

Name	Type	Required	Description
`catalogName`	`string`	`true`	-
`schemaName`	`string`	`true`	-

Code	Description
`201`	The request has succeeded and a new resource has been created as a result.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

/catalogs/{catalogName}/schemas/{schemaName}/volumes/{volumeName}

Operation IDgetVolume

Name	Type	Required	Description
`catalogName`	`string`	`true`	-
`schemaName`	`string`	`true`	-
`volumeName`	`string`	`true`	-

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`404`	The server cannot find the requested resource.
`429`	Client error
`500`	Server error

/catalogs/{catalogName}/schemas/{schemaName}/volumes/{volumeName}

Operation IDupdateVolume

Name	Type	Required	Description
`catalogName`	`string`	`true`	-
`schemaName`	`string`	`true`	-
`volumeName`	`string`	`true`	-

Code	Description
`200`	The request has succeeded.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error

/catalogs/{catalogName}/schemas/{schemaName}/volumes/{volumeName}

Operation IDdeleteVolume

Name	Type	Required	Description
`catalogName`	`string`	`true`	-
`schemaName`	`string`	`true`	-
`volumeName`	`string`	`true`	-

Code	Description
`204`	There is no content to send for this request, but the headers may be useful.
`400`	The server could not understand the request due to invalid syntax.
`401`	Access is unauthorized.
`403`	Access is forbidden.
`429`	Client error
`500`	Server error