Get file storage volume

GET 
/file_storage_volumes/file_storage_volume

Returns details for a file storage volume.

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

file_storage_volume[id] string

The file storage volume to return.

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

Responses

200

Returns details for a file storage volume.

application/json

Schema

Schema

file_storage_volume

object

required

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.

annotations

object[]

required

Array [

key stringrequired

value string

]

Example (from schema)

{
  "file_storage_volume": {
    "id": "string",
    "name": "string",
    "data_center": {
      "id": "string",
      "name": "string",
      "permalink": "string"
    },
    "associations": [
      "string"
    ],
    "state": "pending",
    "nfs_location": "string",
    "size": 0
  },
  "annotations": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

400

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

application/json

Schema

Schema

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string
detail object

Example (from schema)

{
  "code": "missing_api_token",
  "description": "string",
  "detail": {}
}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

PermissionDeniedSchema

The authenticated identity is not permitted to perform this action

code PermissionDeniedEnum (string)

Possible values: [permission_denied]

description string

detail

object

details stringnullable

Additional information regarding the reason why permission was denied

Example (from schema)

{}

404

No file storage volume was found matching any of the criteria provided in the arguments.

application/json

Schema

Schema

code FileStorageVolumeNotFoundEnum (string)

Possible values: [file_storage_volume_not_found]

description string
detail object

Example (from schema)

{
  "code": "file_storage_volume_not_found",
  "description": "string",
  "detail": {}
}

406

The object found is in the trash and therefore cannot be manipulated through the API. It should be restored in order to run this operation.

application/json

Schema

Schema

code ObjectInTrashEnum (string)

Possible values: [object_in_trash]

description string

detail

object

trash_object

object

nullable

id string

keep_until integer

object_id string

object_type string

Example (from schema)

{
  "code": "object_in_trash",
  "description": "string",
  "detail": {
    "trash_object": {
      "id": "string",
      "keep_until": 0,
      "object_id": "string",
      "object_type": "string"
    }
  }
}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...