Update disk

PATCH 
/disks/disk

Update a disk for a given organization.

Scopes

• disks

OAuth2 Scopes

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

Request

application/json

Body

disk

object

required

id string

properties

object

required

name string

bus_type DiskBusEnum (string)

Possible values: [scsi, virtio]

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 FileSystemEnum (string)

Possible values: [ext4, xfs]

storage_speed StorageSpeedEnum (string)

Possible values: [nvme, ssd]

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

object[]

Array [

key stringrequired

value string

]

Responses

200

Update a disk for a given organization.

application/json

Schema

Schema

disk

object

required

id string

name string

size_in_gb integer

wwn string

state DiskStateEnum (string)

Possible values: [not_built, failed, built, building, installing, restoring, formatting, resizing, configuring, importing]

created_at integer

storage_speed StorageSpeedEnum (string)

Possible values: [nvme, ssd]

io_profile

object

nullable

id string

name string

permalink string

speed_in_mb integernullable

iops integernullable

bus_type DiskBusEnum (string)nullable

Possible values: [scsi, virtio]

data_center

object

id string

name string

permalink string

virtual_machine_disk

object

nullable

virtual_machine

object

id string

fqdn string

attach_on_boot boolean

boot boolean

state VirtualMachineDiskAttachmentStateEnum (string)

Possible values: [detached, failed, attached, attaching, detaching]

installation

object

nullable

id string

disk_template_version

object

id string

number integer

stable boolean

size_in_gb integer

disk_template

object

id string

name string

description stringnullable

permalink string

universal boolean

size_in_gb integernullable

latest_version nullable

operating_system

object

nullable

id string

name string

badge

object

nullable

url string

file_name string

file_type string

file_size integer

digest string

token string

attributes

object[]

Array [

key string

label string

value stringnullable

description stringnullable

protect boolean

]

annotations

object[]

required

Annotations for this disk

Array [

key stringrequired

value string

]

Example (from schema)

{
  "disk": {
    "id": "string",
    "name": "string",
    "size_in_gb": 0,
    "wwn": "string",
    "state": "not_built",
    "created_at": 0,
    "storage_speed": "nvme",
    "io_profile": {
      "id": "string",
      "name": "string",
      "permalink": "string",
      "speed_in_mb": 0,
      "iops": 0
    },
    "bus_type": "scsi",
    "data_center": {
      "id": "string",
      "name": "string",
      "permalink": "string"
    },
    "virtual_machine_disk": {
      "virtual_machine": {
        "id": "string",
        "fqdn": "string"
      },
      "attach_on_boot": true,
      "boot": true,
      "state": "detached"
    },
    "installation": {
      "id": "string",
      "disk_template_version": {
        "id": "string",
        "number": 0,
        "stable": true,
        "size_in_gb": 0,
        "disk_template": {
          "id": "string",
          "name": "string",
          "description": "string",
          "permalink": "string",
          "universal": true,
          "size_in_gb": 0,
          "operating_system": {
            "id": "string",
            "name": "string",
            "badge": {
              "url": "string",
              "file_name": "string",
              "file_type": "string",
              "file_size": 0,
              "digest": "string",
              "token": "string"
            }
          }
        }
      },
      "attributes": [
        {
          "key": "string",
          "label": "string",
          "value": "string",
          "description": "string",
          "protect": true
        }
      ]
    }
  },
  "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 disk was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code DiskNotFoundEnum (string)

Possible values: [disk_not_found]

description string
detail object

Example (from schema)

{
  "code": "disk_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"
    }
  }
}

422

422 error response

application/json

Schema

Schema

oneOf

UnassignedDiskSchema

Disk is not assigned to a virtual machine.

code UnassignedDiskEnum (string)

Possible values: [unassigned_disk]

description string

detail object

ValidationErrorSchema

A validation error occurred with the object that was being created/updated/deleted

code ValidationErrorEnum (string)

Possible values: [validation_error]

description string

detail

ValidationError

errors string[]

Example (from schema)

{}

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...