API reference

Import Tools

Account imports from backup files and transfers from remote servers.

List imports

GET/api/v1/imports

Who: root
API tokens: admin token area: server
Operation: importList · ky call importList

Responses

200 OK
Body
Field Type
items array of map of any
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Field	Type
`items`	array of map of any

Import a backup file on the server

POST/api/v1/imports

Who: root
API tokens: admin token area: server
Operation: importCreate · ky call importCreate

Request body

Field	Type
`decisions`	HostingImportDecisions
`path`	string
`url`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
restore_id string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Field	Type
`job_id`	string
`restore_id`	string

Get an import and its analysis

GET/api/v1/imports/{rid}

Who: root
API tokens: admin token area: server
Operation: importGet · ky call importGet

Parameters

Name	In
`rid`	path

Responses

200 OK
Body
map of any
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
500 Internal Server Error: internal

Run an import

POST/api/v1/imports/{rid}/apply

Who: root
API tokens: admin token area: server
Operation: importApply · ky call importApply

Parameters

Name	In
`rid`	path

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: conflicts, not-ready
500 Internal Server Error: internal

Field	Type
`job_id`	string

Cancel an import

POST/api/v1/imports/{rid}/cancel

Who: root
API tokens: admin token area: server
Operation: importCancel · ky call importCancel

Parameters

Name	In
`rid`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: busy
500 Internal Server Error: internal

Resolve an import's conflicts

PUT/api/v1/imports/{rid}/decisions

Who: root
API tokens: admin token area: server
Operation: importDecisions · ky call importDecisions

Parameters

Name	In
`rid`	path

Request body

Field	Type
`auto_apply`	boolean
`ip_id`	string
`keep_dns_ip`	boolean
`overwrite`	boolean
`owner_id`	string
`package_id`	string
`skip_databases`	boolean
`skip_dns`	boolean
`skip_home`	boolean
`skip_mail`	boolean
`url`	string
`username`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: busy
500 Internal Server Error: internal

Field	Type
`job_id`	string

Import every backup in a folder

POST/api/v1/imports/batch

Queues every cPanel backup in a folder of the server; with auto_apply the ones without conflicts are applied right after their analysis.

Who: root
API tokens: admin token area: server
Operation: importBatch · ky call importBatch

Request body

Field	Type
`auto_apply`	boolean
`dir`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
items array of map of string
400 Bad Request: file-operation, validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Field	Type
`items`	array of map of string

Upload a backup file to import

POST/api/v1/imports/upload

Takes a cpmove file as multipart (field "file"; optional "username").

Who: root
API tokens: admin token area: server
Operation: importUpload · ky call importUpload

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
restore_id string
400 Bad Request: invalid-body, upload, validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Field	Type
`job_id`	string
`restore_id`	string

List transfers from remote servers

GET/api/v1/transfers

Who: root
API tokens: admin token area: server
Operation: transferList · ky call transferList

Responses

200 OK
Body
Field Type
items array of StoreTransferSession
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Field	Type
`items`	array of StoreTransferSession

Start a transfer from a remote server

POST/api/v1/transfers

Who: root
API tokens: admin token area: server
Operation: transferCreate · ky call transferCreate

Request body

Field	Type
`auth_method`	string
`host`	string
`password`	string
`port`	integer
`private_key`	string
`user`	string

Responses

201 Created
Body
Field Type
host_key object
Field Type
sha256 string
type string
session StoreTransferSession
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Get a transfer

GET/api/v1/transfers/{tid}

Who: root
API tokens: admin token area: server
Operation: transferGet · ky call transferGet

Parameters

Name	In
`tid`	path

Responses

200 OK
Body
Field Type
items array of map of any
session StoreTransferSession
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
500 Internal Server Error: internal

Field	Type
`items`	array of map of any
`session`	StoreTransferSession

Abort a transfer

POST/api/v1/transfers/{tid}/abort

Who: root
API tokens: admin token area: server
Operation: transferAbort · ky call transferAbort

Parameters

Name	In
`tid`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
500 Internal Server Error: internal

Analyze the remote server's accounts

POST/api/v1/transfers/{tid}/analyze

Who: root
API tokens: admin token area: server
Operation: transferAnalyze · ky call transferAnalyze

Parameters

Name	In
`tid`	path

Responses

200 OK
Body
Field Type
accounts always array of HostingRemoteAccount
at always integer
home_free_kb always integer
type always string
version always string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
500 Internal Server Error: internal
502 Bad Gateway: analysis

Field	Type
`accounts` always	array of HostingRemoteAccount
`at` always	integer
`home_free_kb` always	integer
`type` always	string
`version` always	string

Trust the remote server's SSH host key

POST/api/v1/transfers/{tid}/host-key

Who: root
API tokens: admin token area: server
Operation: transferHostKey · ky call transferHostKey

Parameters

Name	In
`tid`	path

Request body

Field	Type
`sha256`	string

Responses

200 OK
Body
Field Type
host_key string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: host-key
500 Internal Server Error: internal
502 Bad Gateway: unreachable

Field	Type
`host_key`	string

Copy the chosen accounts

POST/api/v1/transfers/{tid}/start

Who: root
API tokens: admin token area: server
Operation: transferStart · ky call transferStart

Parameters

Name	In
`tid`	path

Request body

Field	Type
`accounts`	array of object

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Import Tools

#List imports

Responses

#Import a backup file on the server

Request body

Responses

#Get an import and its analysis

Parameters

Responses

#Run an import

Parameters

Responses

#Cancel an import

Parameters

Responses

#Resolve an import's conflicts

Parameters

Request body

Responses

#Import every backup in a folder

Request body

Responses

#Upload a backup file to import

Responses

#List transfers from remote servers

Responses

#Start a transfer from a remote server

Request body

Responses

#Get a transfer

Parameters

Responses

#Abort a transfer

Parameters

Responses

#Analyze the remote server's accounts

Parameters

Responses

#Trust the remote server's SSH host key

Parameters

Request body

Responses

#Copy the chosen accounts

Parameters

Request body

Responses

List imports

Import a backup file on the server

Get an import and its analysis

Run an import

Cancel an import

Resolve an import's conflicts

Import every backup in a folder

Upload a backup file to import

List transfers from remote servers

Start a transfer from a remote server

Get a transfer

Abort a transfer

Analyze the remote server's accounts

Trust the remote server's SSH host key

Copy the chosen accounts