https://api.katapult.io/core/v1/organizations/organization/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 |
|
|
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 |
|
|
permission_denied
|
The authenticated identity is not permitted to perform this action |
|
|
organization_not_found
|
No organization was found matching any of the criteria provided in the arguments |
|
|
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 |
organization
object
required
body
All 'organization[]' params are mutually exclusive, only one can be provided.
id
string
sub_domain
string
target
object
body
virtual_machine
object
All 'virtual_machine[]' params are mutually exclusive, only one can be provided.
id
string
fqdn
string
disk
object
id
string
properties
object
required
body
description
string
Optional description to help identify the backup policy.
global_policy
boolean
When true the policy applies to all disks in the organisation. The target argument becomes optional when this is set.
retention
integer
schedule
object
frequency
integer
How often the schedule repeats within the given interval (e.g. every 2 hours for hourly).
interval
string
minute
integer
The minute within the hour at which the schedule triggers (0–59). When omitted the server assigns a random value to spread load; read the value back from the response to avoid state drift.
time
integer
The sub-interval offset whose meaning depends on the chosen interval: unused for hourly; hour of day (0–23) for daily; day of week (0 = Sunday, 6 = Saturday) for weekly; day of month (1–28) for monthly.
disk_backup_policy
The new disk backup policy that has been created
{
"disk_backup_policy": "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.