Skip to main content

List file storage volumes

GET 

/organizations/organization/file_storage_volumes

Returns a list of all file storage volumes for a given organization

Scopes

  • file_storage_volumes
  • file_storage_volumes:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    organization[id] string

    The organization to return all file storage volumes for.

    All 'organization[]' params are mutually exclusive, only one can be provided.

    organization[sub_domain] string

    The organization to return all file storage volumes for.

    All 'organization[]' params are mutually exclusive, only one can be provided.

    annotations[][key] string[]

    An array of annotations to filter by.

    All annotations[] params should have the same amount of elements.

    annotations[][value] string[]

    An array of annotations to filter by.

    All annotations[] params should have the same amount of elements.

    page integer

    Possible values: >= 1

    Default value: 1

    The page number to request. If not provided, the first page will be returned.

    per_page integer

    Possible values: >= 1

    Default value: 30

    The number of items to return per page. If not provided, the default value will be used.

Responses

Returns a list of all file storage volumes for a given organization

Schema

    pagination

    object

    required

    current_page integer

    The current page

    total_pages integernullable

    The total number of pages

    total integernullable

    The total number of items across all pages

    per_page integer

    The number of items per page

    large_set boolean

    Is this a large set and therefore the total number of records cannot be returned?

    file_storage_volumes

    object[]

    required

    A list of all file storage volumes for the given organization.

  • Array [

  • id string
    name string

    data_center

    object

    id string
    name string
    permalink string
    associations string[]
    state FileStorageVolumeStateEnum (string)

    Possible values: [pending, failed, ready, configuring]

    nfs_location stringnullable

    The NFS location of where to mount the volume from.

    size integernullable

    The size of the volume in bytes.

  • ]

Loading...