https://api.katapult.io/core/v1/organizations/organization/disks
| Code | Error | When it happens |
|---|---|---|
|
|
missing_api_token
|
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer |
|
|
unauthorized_network_for_api_token
|
Network is not allowed to access the API with this API token |
|
|
invalid_api_token
|
The API token provided was not valid (it may not exist or have expired) |
|
|
token_owner_suspended
|
The user that owns the API token has been suspended |
|
|
invalid_capabilities_token
|
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key) |
|
|
scope_not_granted
|
The scope required for this endpoint has not been granted to the authenticating identity |
|
|
organization_suspended
|
An organization was found from the arguments provided but it was suspended |
|
|
organization_not_activated
|
An organization was found from the arguments provided but it wasn't activated yet |
|
|
organization_not_found
|
No organization was found matching any of the criteria provided in the arguments |
|
|
rate_limit_reached
|
You have reached the rate limit for this type of request |
|
|
service_unavailable
|
The service is currently unavailable, please try again later |
organization[id]
string
query
The organization to find disks for. All 'organization[]' params are mutually exclusive, only one can be provided.
organization[sub_domain]
string
query
The organization to find disks for. All 'organization[]' params are mutually exclusive, only one can be provided.
annotations[][key]
array
query
An array of annotations to filter by. All `annotations[]` params should have the same amount of elements.
annotations[][value]
array
query
An array of annotations to filter by. All `annotations[]` params should have the same amount of elements.
page
integer
query
The page number to request. If not provided, the first page will be returned.
per_page
integer
query
The number of items to return per page. If not provided, the default value will be used.
pagination
object
current_page
integer
The current page
total_pages
integer
The total number of pages
total
integer
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?
disk
array
The list of disks
id
string
name
string
size_in_gb
integer
wwn
string
state
string
virtual_machine_disk
{
"pagination": {
"current_page": 0,
"total_pages": 0,
"total": 0,
"per_page": 0,
"large_set": true
},
"disk": [
{
"id": "string",
"name": "string",
"size_in_gb": 0,
"wwn": "string",
"state": "not_built",
"virtual_machine_disk": "string"
}
]
}Sent to https://api.katapult.io/core/v1 as a bearer token and never to Krystal Documentation. It isn't stored anywhere, so paste it again on each endpoint page.
Left blank, a parameter is omitted from the request.