API reference

Domains

Main, addon, subdomain and alias domains; document roots, PHP version and settings, redirects, error pages.

List domains

GET/api/v1/accounts/{id}/domains

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Operation: listDomains · ky call listDomains

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
home_dir string
items array of DomainView
limits object
Field Type
addon LimitView
alias LimitView
sub LimitView
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

Add a domain (addon, subdomain or alias)

POST/api/v1/accounts/{id}/domains

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: domains
Operation: createDomain · ky call createDomain

Parameters

Name	In
`id`	path

Request body

Field	Type
`docroot`	string
`label`	string
`name`	string
`parent_id`	string
`type`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
domain StoreDomainRow
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: account-not-active, limit-reached, validation
500 Internal Server Error: internal

Field	Type
`domain`	StoreDomainRow
`job_id`	string

Remove a domain

DELETE/api/v1/accounts/{id}/domains/{did}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: domains
Operation: deleteDomain · ky call deleteDomain

Parameters

Name	In
`id`	path
`did`	path
`confirm`	query
`remove_files`	query

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
400 Bad Request: confirmation-required
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: already-removing, has-subdomains, main-domain, still-provisioning
500 Internal Server Error: internal

Field	Type
`job_id`	string

Get a domain

GET/api/v1/accounts/{id}/domains/{did}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Operation: getDomain · ky call getDomain

Parameters

Name	In
`id`	path
`did`	path

Responses

200 OK

Body

Field	Type
`docroot`	string
`force_https`	boolean
`id`	string
`name`	string
`parent_id`	string
`parent_name`	string
`php_ini_count` always	integer
`php_version`	string
`redirect_count` always	integer
`redirect_to`	string
`ssl`	DomainSSLView
`status`	string
`subdomains` always	integer
`type`	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

Include or exclude a domain from AutoSSL

PUT/api/v1/accounts/{id}/domains/{did}/autossl

Who: root, reseller (ACL: ssl or create-user-session); customer
API tokens: admin token area: accounts; account token area: ssl
Feature: ssl_status
Operation: sslAutoSSLExclude · ky call sslAutoSSLExclude

Parameters

Name	In
`id`	path
`did`	path

Request body

Field	Type
`excluded`	boolean

Responses

200 OK
Body
Field Type
excluded boolean
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

Change a domain's document root

PUT/api/v1/accounts/{id}/domains/{did}/docroot

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: domains
Operation: setDocroot · ky call setDocroot

Parameters

Name	In
`id`	path
`did`	path

Request body

Field	Type
`docroot`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
docroot string
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: alias, already-removing
500 Internal Server Error: internal

Turn HTTPS redirection on or off

PUT/api/v1/accounts/{id}/domains/{did}/force-https

Who: root, reseller (ACL: ssl or create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: domains
Operation: setForceHTTPS · ky call setForceHTTPS

Parameters

Name	In
`id`	path
`did`	path

Request body

Field	Type
`enabled`	boolean

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: no-certificate
500 Internal Server Error: internal

Field	Type
`job_id`	string

Change a domain's PHP version

PUT/api/v1/accounts/{id}/domains/{did}/php

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: php_version
Operation: setDomainPHP · ky call setDomainPHP

Parameters

Name	In
`id`	path
`did`	path

Request body

Field	Type
`version`	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
500 Internal Server Error: internal

Field	Type
`job_id`	string

Get a domain's PHP settings

GET/api/v1/accounts/{id}/domains/{did}/php-ini

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: php_ini
Operation: getPHPIni · ky call getPHPIni

Parameters

Name	In
`id`	path
`did`	path

Responses

200 OK
Body
Field Type
directives array of WebDirective
domain string
domain_id string
php_version string
values map of 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: alias
500 Internal Server Error: internal

Field	Type
`directives`	array of WebDirective
`domain`	string
`domain_id`	string
`php_version`	string
`values`	map of string

Save a domain's PHP settings

PUT/api/v1/accounts/{id}/domains/{did}/php-ini

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: php_ini
Operation: setPHPIni · ky call setPHPIni

Parameters

Name	In
`id`	path
`did`	path

Request body

Field	Type
`values`	map of string

Responses

202 Accepted (runs in the background)
Body
Field Type
job_id string
values map of 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: alias
500 Internal Server Error: internal

Field	Type
`job_id`	string
`values`	map of string

List custom error pages

GET/api/v1/accounts/{id}/error-pages

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: error-pages
Feature: error_pages
Operation: errorPagesList · ky call errorPagesList

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
codes array of integer
items array of StoreErrorPageRow
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
`codes`	array of integer
`items`	array of StoreErrorPageRow

Save a custom error page

PUT/api/v1/accounts/{id}/error-pages/{did}/{code}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: error-pages
Feature: error_pages
Operation: errorPageSave · ky call errorPageSave

Parameters

Name	In
`id`	path
`did`	path
`code`	path

Request body

Field	Type
`html`	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
500 Internal Server Error: internal

Field	Type
`job_id`	string

List redirects

GET/api/v1/accounts/{id}/redirects

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: redirects
Operation: listRedirects · ky call listRedirects

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
items array of StoreRedirectRow
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 StoreRedirectRow

Add a redirect

POST/api/v1/accounts/{id}/redirects

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: redirects
Operation: createRedirect · ky call createRedirect

Parameters

Name	In
`id`	path

Request body

Field	Type
`code`	integer
`domain_id`	string
`path`	string
`target_url`	string
`wildcard`	boolean
`www_mode`	string

Responses

200 OK
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: validation
500 Internal Server Error: internal

Delete a redirect

DELETE/api/v1/accounts/{id}/redirects/{rid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: redirects
Operation: deleteRedirect · ky call deleteRedirect

Parameters

Name	In
`id`	path
`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
500 Internal Server Error: internal

Field	Type
`job_id`	string

Update a redirect

PUT/api/v1/accounts/{id}/redirects/{rid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: domains
Feature: redirects
Operation: updateRedirect · ky call updateRedirect

Parameters

Name	In
`id`	path
`rid`	path

Request body

Field	Type
`code`	integer
`domain_id`	string
`path`	string
`target_url`	string
`wildcard`	boolean
`www_mode`	string

Responses

200 OK
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: validation
500 Internal Server Error: internal

Directory indexes, hotlink protection and IP blocks

GET/api/v1/accounts/{id}/web-options

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: web-options
Operation: webOptionsGet · ky call webOptionsGet

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
hotlink always StoreHotlinkSettings
indexes always array of StoreIndexSetting
ip_blocks always array of StoreIPBlock
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
`hotlink` always	StoreHotlinkSettings
`indexes` always	array of StoreIndexSetting
`ip_blocks` always	array of StoreIPBlock

List the server's domains by type

GET/api/v1/server/domains

List Subdomains (?type=sub) and List Parked Domains (?type=alias), or addon domains.

Who: root, reseller (ACL: list-accts)
API tokens: admin token area: server
Operation: serverDomains · ky call serverDomains

Parameters

Name	In
`type`	query

Responses

200 OK
Body
Field Type
items array of StoreServerDomain
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

Domains

#List domains

Parameters

Responses

#Add a domain (addon, subdomain or alias)

Parameters

Request body

Responses

#Remove a domain

Parameters

Responses

#Get a domain

Parameters

Responses

#Include or exclude a domain from AutoSSL

Parameters

Request body

Responses

#Change a domain's document root

Parameters

Request body

Responses

#Turn HTTPS redirection on or off

Parameters

Request body

Responses

#Change a domain's PHP version

Parameters

Request body

Responses

#Get a domain's PHP settings

Parameters

Responses

#Save a domain's PHP settings

Parameters

Request body

Responses

#List custom error pages

Parameters

Responses

#Save a custom error page

Parameters

Request body

Responses

#List redirects

Parameters

Responses

#Add a redirect

Parameters

Request body

Responses

#Delete a redirect

Parameters

Responses

#Update a redirect

Parameters

Request body

Responses

#Directory indexes, hotlink protection and IP blocks

Parameters

Responses

#List the server's domains by type

Parameters

Responses

List domains

Add a domain (addon, subdomain or alias)

Remove a domain

Get a domain

Include or exclude a domain from AutoSSL

Change a domain's document root

Turn HTTPS redirection on or off

Change a domain's PHP version

Get a domain's PHP settings

Save a domain's PHP settings

List custom error pages

Save a custom error page

List redirects

Add a redirect

Delete a redirect

Update a redirect

Directory indexes, hotlink protection and IP blocks

List the server's domains by type