List disk backup policies

GET 
/organizations/organization/disk_backup_policies

Returns a list of all disk backup policies for a given organization

Scopes

• disk_backup_policies
• disk_backup_policies:read

OAuth2 Scopes

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

Request

Query Parameters

organization[id] string

The organization to return disk backup policies for.

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

organization[sub_domain] string

The organization to return disk backup policies for.

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

page integer

Possible values: >= 1

Default value: 1

The page number to request. If not provided, the first page will be returned.

per_page integer

Possible values: >= 1

Default value: 30

The number of items to return per page. If not provided, the default value will be used.

Responses

200

Returns a list of all disk backup policies for a given organization

application/json

Schema

Schema

pagination

object

required

current_page integer

The current page

total_pages integernullable

The total number of pages

total integernullable

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_backup_policies

object[]

required

The disk backup policies for the provided organization

Array [

id string

retention integer

total_size float

target

object

target

object

oneOf

VirtualMachine

id string

name string

hostname string

fqdn string

description stringnullable

created_at integer

initial_root_password stringnullable

state VirtualMachineStateEnum (string)

Possible values: [stopped, failed, started, starting, allocated, allocating, resetting, migrating, stopping, shutting_down, transferring, orphaned]

zone

object

id string

name string

permalink stringnullable

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

organization

object

id string

name string

sub_domain string

infrastructure_domain string

created_at integer

activated_at integernullable

suspended boolean

managed boolean

billing_name stringnullable

address1 stringnullable

address2 stringnullable

address3 stringnullable

address4 stringnullable

postcode stringnullable

vat_number stringnullable

phone_number stringnullable

currency

object

id string

name string

iso_code string

symbol string

country

object

nullable

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

country_state

object

nullable

id string

name string

code string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

group

object

nullable

id string

name string

segregate boolean

auto_segregate boolean

created_at integer

package

object

nullable

id string

name string

permalink string

cpu_cores integer

ipv4_addresses integer

memory_in_gb integer

storage_in_gb integer

monthly_bandwidth_allowance_in_gb integernullable

privacy PrivacyTypesEnum (string)

Possible values: [public, private]

icon

object

nullable

url string

file_name string

file_type string

file_size integer

digest string

token string

use_dedicated_cpus boolean

group

object

id string

name string

attached_iso

object

nullable

id string

name string

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

memory_in_gb integernullable

cpu_cores integernullable

use_dedicated_cpus booleannullable

gpu_type

object

nullable

id string

name string

manufacturer string

memory_in_gb integer

memory_type string

permalink string

data_centers

object[]

Array [

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

]

gpus

object[]

Array [

id stringnullable

Unique ID for this GPU. Not available when status is "detached".

status VirtualMachineGPUStatusEnum (string)

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

pending_action VirtualMachineGPUPendingActionEnum (string)

Possible values: [attach, detach]

available boolean

When pending action is "attach", this indicates if there is a GPU of the relevant type available.

type

object

id string

name string

manufacturer string

memory_in_gb integer

memory_type string

permalink string

data_centers object[]

]

tags

object[]

Array [

id string

name string

color TagColorsEnum (string)

Possible values: [red, pink, purple, dark_blue, green, teal, aqua, light_blue, yellow, orange, orange_red, brown, black, dark_gray, light_gray, light_brown, pastel_red, pastel_pink, pastel_purple, pastel_dark_blue, pastel_green, pastel_teal, pastel_aqua, pastel_light_blue, pastel_yellow, pastel_orange, pastel_orange_red, pastel_brown, pastel_black, pastel_dark_gray, pastel_light_gray, pastel_light_brown]

created_at integer

]

tag_names string[]

ip_addresses

object[]

Array [

id string

address string

reverse_dns string

vip boolean

label stringnullable

address_with_mask string

network

object

id string

name string

permalink stringnullable

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

allocation_id stringnullable

allocation_type stringnullable

]

hypervisor

object

nullable

id string

name string

ip_address string

Disk

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)

Possible values: [scsi, virtio]

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

virtual_machine_disk

object

nullable

virtual_machine

object

id string

name string

hostname string

fqdn string

description stringnullable

created_at integer

initial_root_password stringnullable

state VirtualMachineStateEnum (string)

Possible values: [stopped, failed, started, starting, allocated, allocating, resetting, migrating, stopping, shutting_down, transferring, orphaned]

zone

object

id string

name string

permalink stringnullable

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

organization

object

id string

name string

sub_domain string

infrastructure_domain string

created_at integer

activated_at integernullable

suspended boolean

managed boolean

billing_name stringnullable

address1 stringnullable

address2 stringnullable

address3 stringnullable

address4 stringnullable

postcode stringnullable

vat_number stringnullable

phone_number stringnullable

currency

object

id string

name string

iso_code string

symbol string

country

object

nullable

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

country_state

object

nullable

id string

name string

code string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

group

object

nullable

id string

name string

segregate boolean

auto_segregate boolean

created_at integer

package

object

nullable

id string

name string

permalink string

cpu_cores integer

ipv4_addresses integer

memory_in_gb integer

storage_in_gb integer

monthly_bandwidth_allowance_in_gb integernullable

privacy PrivacyTypesEnum (string)

Possible values: [public, private]

icon

object

nullable

url string

file_name string

file_type string

file_size integer

digest string

token string

use_dedicated_cpus boolean

group

object

id string

name string

attached_iso

object

nullable

id string

name string

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

memory_in_gb integernullable

cpu_cores integernullable

use_dedicated_cpus booleannullable

gpu_type

object

nullable

id string

name string

manufacturer string

memory_in_gb integer

memory_type string

permalink string

data_centers

object[]

Array [

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

]

gpus

object[]

Array [

id stringnullable

Unique ID for this GPU. Not available when status is "detached".

status VirtualMachineGPUStatusEnum (string)

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

pending_action VirtualMachineGPUPendingActionEnum (string)nullable

Possible values: [attach, detach]

available boolean

When pending action is "attach", this indicates if there is a GPU of the relevant type available.

type

object

id string

name string

manufacturer string

memory_in_gb integer

memory_type string

permalink string

data_centers

object[]

Array [

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

]

]

tags

object[]

Array [

id string

name string

color TagColorsEnum (string)

Possible values: [red, pink, purple, dark_blue, green, teal, aqua, light_blue, yellow, orange, orange_red, brown, black, dark_gray, light_gray, light_brown, pastel_red, pastel_pink, pastel_purple, pastel_dark_blue, pastel_green, pastel_teal, pastel_aqua, pastel_light_blue, pastel_yellow, pastel_orange, pastel_orange_red, pastel_brown, pastel_black, pastel_dark_gray, pastel_light_gray, pastel_light_brown]

created_at integer

]

tag_names string[]

ip_addresses

object[]

Array [

id string

address string

reverse_dns string

vip boolean

label stringnullable

address_with_mask string

network

object

id string

name string

permalink stringnullable

data_center

object

id string

name string

permalink string

country

object

id string

name string

iso_code2 string

iso_code3 string

time_zone stringnullable

eu boolean

allocation_id stringnullable

allocation_type stringnullable

]

hypervisor

object

nullable

id string

name string

ip_address string

disk

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

]

schedule

object

interval ScheduleIntervalTypeEnum (string)

Possible values: [hourly, daily, weekly, monthly]

next_invocation_at integer

]

Example (from schema)

{
  "pagination": {
    "current_page": 0,
    "total_pages": 0,
    "total": 0,
    "per_page": 0,
    "large_set": true
  },
  "disk_backup_policies": [
    {
      "id": "string",
      "retention": 0,
      "total_size": 0,
      "target": {
        "target": {}
      },
      "schedule": {
        "interval": "hourly",
        "next_invocation_at": 0
      }
    }
  ]
}

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[]

OrganizationSuspendedSchema

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

code OrganizationSuspendedEnum (string)

Possible values: [organization_suspended]

description string

detail object

OrganizationNotActivatedSchema

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

code OrganizationNotActivatedEnum (string)

Possible values: [organization_not_activated]

description string

detail object

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 organization was found matching any of the criteria provided in the arguments

application/json

Schema

Schema

code OrganizationNotFoundEnum (string)

Possible values: [organization_not_found]

description string
detail object

Example (from schema)

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

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