API Reference

Katapult Core API

Resources & Endpoints

List file storage volumes

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

GET
https://api.katapult.io/core/v1/organizations/{organization}/file_storage_volumes

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

organization Required

The organization to return all file storage volumes for.

 Organization Lookup None

annotations

An array of annotations to filter by

 KeyValue Array None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    file_storage_volumes: [ FileStorageVolume {
        id: String
        name: String
        data_center: DataCenter {
            id: String
            name: String
            permalink: String
        }
        associations: [ String ]
        state: FileStorageVolumeStateEnum
        nfs_location: String?
        size: Integer?
    } ]
}