Skip to main content
POST
Start the offered backup month

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

instance_id
string<uuid>
required
organization_id
string<uuid>
required
project_id
string<uuid>
required

Response

202 - application/json
id
string<uuid>
required
read-only
instance
string<uuid>
required
read-only
instance_name
string
required
read-only
whmcs_service_id
integer
required
read-only
whmcs_order_id
integer | null
required
read-only
whmcs_invoice_id
integer | null
required
read-only
status
enum<string>
required
read-only
  • pending - Pending
  • active - Active
  • converted - Converted
  • cancelled - Cancelled
  • failed - Failed
Available options:
pending,
active,
converted,
cancelled,
failed
source
enum<string>
required
read-only
  • staff - Staff
  • self_service - Self service
Available options:
staff,
self_service
trial
boolean
required
read-only
cycle
string
required
read-only
monthly_price
string
required
read-only
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
cycle_price
string
required
read-only
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
credited
string
required
read-only
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
started_at
string<date-time> | null
required
read-only
ends_at
string<date-time> | null
required
read-only
reminded_at
string<date-time> | null
required
read-only
resolved_at
string<date-time> | null
required
read-only
failure_reason
string
required
read-only
created
string<date-time>
required
read-only