https://api.katapult.io/core/v1/disks/disk
| 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 |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
disk_not_found
|
No disk was found matching any of the criteria provided in the arguments |
|
|
object_in_trash
|
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. |
|
|
unassigned_disk
|
Disk is not assigned to a virtual machine. |
|
|
validation_error
|
A validation error occurred with the object that was being created/updated/deleted |
|
|
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 |
disk
object
required
body
id
string
properties
object
required
body
name
string
bus_type
string
data_center
object
All 'data_center[]' params are mutually exclusive, only one can be provided.
id
string
permalink
string
size_in_gb
integer
Only available when creating disk. Existing disks must use the resize endpoint.
io_profile
object
All 'io_profile[]' params are mutually exclusive, only one can be provided.
id
string
permalink
string
initial_file_system
string
storage_speed
string
virtual_machine_disk
object
boot
boolean
attach_on_boot
boolean
Attach the disk during virtual machine start up. Default is true.
attach
boolean
Attach the disk once built. If the virtual machine is not running the disk will attach when started. Only available when creating disk, existing disks must use the attach endpoint.
virtual_machine
object
All 'virtual_machine[]' params are mutually exclusive, only one can be provided.
id
string
fqdn
string
annotations
array
body
key
string
value
string
disk
The disk that has been updated.
annotations
array
Annotations for this disk
key
string
value
string
{
"disk": "string",
"annotations": [
{
"key": "string",
"value": "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.
Pre-filled with the endpoint's shape — declared defaults where it has them, otherwise a placeholder per type. Edit it before executing; the Arguments tab documents every field.