API reference

SSL/TLS

Certificates, keys, CSRs and AutoSSL.

Run AutoSSL for the account

POST/api/v1/accounts/{id}/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: runAutoSSL · ky call runAutoSSL

Parameters

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

Field	Type
`job_id`	string

SSL status of every domain

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

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

Parameters

Name	In
`id`	path

Responses

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

List certificates

GET/api/v1/accounts/{id}/ssl/certs

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

Parameters

Name	In
`id`	path

Responses

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

Upload a certificate

POST/api/v1/accounts/{id}/ssl/certs

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

Parameters

Name	In
`id`	path

Request body

Field	Type
`ca_bundle`	string
`cert_id`	string
`certificate`	string
`domain_id`	string
`friendly_name`	string
`private_key`	string

Responses

201 Created
Body
Field Type
cert StoreSSLCert
preview CertPreview
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

Field	Type
`cert`	StoreSSLCert
`preview`	CertPreview

Delete a certificate

DELETE/api/v1/accounts/{id}/ssl/certs/{cid}

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

Parameters

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

Get a certificate

GET/api/v1/accounts/{id}/ssl/certs/{cid}

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

Parameters

Name	In
`id`	path
`cid`	path

Responses

200 OK
Body
Field Type
cert StoreSSLCert
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
`cert`	StoreSSLCert

Check a certificate, key and CA bundle

POST/api/v1/accounts/{id}/ssl/check

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

Parameters

Name	In
`id`	path

Request body

Field	Type
`ca_bundle`	string
`cert_id`	string
`certificate`	string
`domain_id`	string
`friendly_name`	string
`private_key`	string

Responses

200 OK

Body

Field	Type
`chain_certs` always	integer
`covers_domain`	boolean
`domains` always	array of string
`issuer` always	string
`key_match` always	boolean
`key_stored` always	boolean
`not_after` always	integer
`not_before` always	integer
`validation` always	string
`warnings` always	array 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)
500 Internal Server Error: internal

List certificate signing requests

GET/api/v1/accounts/{id}/ssl/csrs

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

Parameters

Name	In
`id`	path

Responses

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

Create a certificate signing request

POST/api/v1/accounts/{id}/ssl/csrs

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

Parameters

Name	In
`id`	path

Request body

Field	Type
`domains`	array of string
`friendly_name`	string
`key_id`	string
`key_type`	string
`subject`	HostingCSRSubject

Responses

201 Created
Body
Field Type
csr StoreSSLCSR
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

Field	Type
`csr`	StoreSSLCSR

Delete a certificate signing request

DELETE/api/v1/accounts/{id}/ssl/csrs/{cid}

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

Parameters

Name	In
`id`	path
`cid`	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

Install a certificate on a domain

POST/api/v1/accounts/{id}/ssl/install

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

Parameters

Name	In
`id`	path

Request body

Field	Type
`ca_bundle`	string
`cert_id`	string
`certificate`	string
`domain_id`	string
`friendly_name`	string
`private_key`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
cert_id string
job_id string
warnings array 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: not-ready
500 Internal Server Error: internal

Field	Type
`cert_id`	string
`job_id`	string
`warnings`	array of string

Uninstall a domain's certificate

DELETE/api/v1/accounts/{id}/ssl/installs/{did}

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

Parameters

Name	In
`id`	path
`did`	path

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

Field	Type
`job_id`	string

List private keys

GET/api/v1/accounts/{id}/ssl/keys

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

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
items array of StoreSSLKey
types array 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)
500 Internal Server Error: internal

Field	Type
`items`	array of StoreSSLKey
`types`	array of string

Generate or upload a private key

POST/api/v1/accounts/{id}/ssl/keys

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

Parameters

Name	In
`id`	path

Request body

Field	Type
`friendly_name`	string
`pem`	string
`type`	string

Responses

201 Created
Body
Field Type
key StoreSSLKey
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

Field	Type
`key`	StoreSSLKey

Delete a private key

DELETE/api/v1/accounts/{id}/ssl/keys/{kid}

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

Parameters

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

Get a private key

GET/api/v1/accounts/{id}/ssl/keys/{kid}

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

Parameters

Name	In
`id`	path
`kid`	path

Responses

200 OK
Body
Field Type
key StoreSSLKey
pem 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
`key`	StoreSSLKey
`pem`	string

AutoSSL settings and status

GET/api/v1/server/ssl/autossl

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

Responses

200 OK
Body
Field Type
accounts array of StoreAutoSSLAccount
interval_hours integer
key_types array of string
profiles array of map of any
provider string
queue array of StoreJobRun
settings HostingSSLSettings
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
`accounts`	array of StoreAutoSSLAccount
`interval_hours`	integer
`key_types`	array of string
`profiles`	array of map of any
`provider`	string
`queue`	array of StoreJobRun
`settings`	HostingSSLSettings

Run AutoSSL for every account

POST/api/v1/server/ssl/autossl/run

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

Request body

Field	Type
`account_id`	string
`hostname`	boolean

Responses

202 Accepted (runs in the background)
Body
Field Type
job_ids array of string
queued integer
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_ids`	array of string
`queued`	integer

List AutoSSL runs

GET/api/v1/server/ssl/autossl/runs

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

Parameters

Name	In
`limit`	query
`status`	query

Responses

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

AutoSSL run log

GET/api/v1/server/ssl/autossl/runs/{jid}/log

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

Parameters

Name	In
`jid`	path

Responses

200 OK
Body
Field Type
job StoreJob
lines array of StoreJobLog
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`	StoreJob
`lines`	array of StoreJobLog

Save the AutoSSL settings

PUT/api/v1/server/ssl/autossl/settings

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

Request body

Field	Type
`key_type`	string
`profile`	string

Responses

200 OK
Body
Field Type
key_type string
profile 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

List every installed certificate

GET/api/v1/server/ssl/certificates

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

Responses

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

Request a certificate for the server's hostname

POST/api/v1/server/ssl/hostname

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

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)
409 Conflict: already-running
500 Internal Server Error: internal

Field	Type
`job_id`	string

Install a certificate on any domain

POST/api/v1/server/ssl/install

Installs a pasted certificate (with its key) on any site, by domain name.

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

Request body

Field	Type
`ca_bundle`	string
`cert_id`	string
`certificate`	string
`domain`	string
`domain_id`	string
`friendly_name`	string
`private_key`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
account_id string
cert_id string
job_id string
warnings array 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)
500 Internal Server Error: internal

SSL/TLS

#Run AutoSSL for the account

Parameters

Responses

#SSL status of every domain

Parameters

Responses

#List certificates

Parameters

Responses

#Upload a certificate

Parameters

Request body

Responses

#Delete a certificate

Parameters

Responses

#Get a certificate

Parameters

Responses

#Check a certificate, key and CA bundle

Parameters

Request body

Responses

#List certificate signing requests

Parameters

Responses

#Create a certificate signing request

Parameters

Request body

Responses

#Delete a certificate signing request

Parameters

Responses

#Install a certificate on a domain

Parameters

Request body

Responses

#Uninstall a domain's certificate

Parameters

Responses

#List private keys

Parameters

Responses

#Generate or upload a private key

Parameters

Request body

Responses

#Delete a private key

Parameters

Responses

#Get a private key

Parameters

Responses

#AutoSSL settings and status

Responses

#Run AutoSSL for every account

Request body

Responses

#List AutoSSL runs

Parameters

Responses

#AutoSSL run log

Parameters

Responses

#Save the AutoSSL settings

Request body

Responses

#List every installed certificate

Responses

#Request a certificate for the server's hostname

Responses

#Install a certificate on any domain

Request body

Responses

Run AutoSSL for the account

SSL status of every domain

List certificates

Upload a certificate

Delete a certificate

Get a certificate

Check a certificate, key and CA bundle

List certificate signing requests

Create a certificate signing request

Delete a certificate signing request

Install a certificate on a domain

Uninstall a domain's certificate

List private keys

Generate or upload a private key

Delete a private key

Get a private key

AutoSSL settings and status

Run AutoSSL for every account

List AutoSSL runs

AutoSSL run log

Save the AutoSSL settings

List every installed certificate

Request a certificate for the server's hostname

Install a certificate on any domain