https://api.katapult.io/core/v1/virtual_machines/virtual_machine/disk_backup_policies
| 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 |
|
|
virtual_machine_not_found
|
No virtual machine 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. |
|
|
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 |
virtual_machine[id]
string
query
The virtual machine to return disk backup policies for. All 'virtual_machine[]' params are mutually exclusive, only one can be provided.
virtual_machine[fqdn]
string
query
The virtual machine to return disk backup policies for. All 'virtual_machine[]' params are mutually exclusive, only one can be provided.
include_disks
boolean
query
If true, the returned list will include backup policies owned by disks assigned to this virtual machine in addition to those that belong to the whole virtual machine
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_backup_policies
array
The disk backup policies for the provided virtual machine
id
string
description
string
retention
integer
total_size
number
target
schedule
object
interval
string
next_invocation_at
integer
When this schedule will next fire.
{
"pagination": {
"current_page": 0,
"total_pages": 0,
"total": 0,
"per_page": 0,
"large_set": true
},
"disk_backup_policies": [
{
"id": "string",
"description": "string",
"retention": 0,
"total_size": 0,
"target": "string",
"schedule": {
"interval": "hourly",
"next_invocation_at": 0
}
}
]
}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.