Security

#Save hotlink protection

PUT/api/v1/accounts/{id}/hotlink

Who

root, reseller (ACL: create-user-session); customer

API tokens

admin token area: accounts; account token area: hotlink

Feature

hotlink

Operation

hotlinkSave · ky call hotlinkSave

Parameters

Request body

Responses

• 202 Accepted (runs in the background)
  Body

  Field	Type
  job_id	string
  options	StoreWebOptions

• 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

#Unblock an IP address from the account's sites

DELETE/api/v1/accounts/{id}/ip-blocks

Who

root, reseller (ACL: create-user-session); customer

API tokens

admin token area: accounts; account token area: ip-blocks

Feature

ip_blocker

Operation

ipBlockRemove · ky call ipBlockRemove

Parameters

Responses

• 202 Accepted (runs in the background)
  Body

  Field	Type
  job_id	string
  options	StoreWebOptions

• 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

#Block an IP address from the account's sites

POST/api/v1/accounts/{id}/ip-blocks

Who

root, reseller (ACL: create-user-session); customer

API tokens

admin token area: accounts; account token area: ip-blocks

Feature

ip_blocker

Operation

ipBlockAdd · ky call ipBlockAdd

Parameters

Request body

Responses

• 202 Accepted (runs in the background)
  Body

  Field	Type
  job_id	string
  options	StoreWebOptions

• 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

#Minimum password strength

GET/api/v1/password-policy

Tells password forms the minimum strength per kind of password (not secret: it is enforced anyway).

Who

public

API tokens

not needed

Operation

passwordPolicy · ky call passwordPolicy

Responses

• 200 OK
  Body

  Field	Type
  min_length	integer
  minimums	map of integer

#Two-factor authentication overview

GET/api/v1/security/2fa

Who

root

API tokens

API tokens can't use this endpoint

Operation

twoFAOverview · ky call twoFAOverview

Responses

• 200 OK
  Body

  Field	Type
  admins	array of StoreAdminTwoFactor
  customers	object Field Type total integer with_2fa integer
  issuer	string
  issuer_effective	string
  me	string
  require_2fa_admins	boolean
  require_2fa_customers	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)
• 500 Internal Server Error: internal

#Turn off an admin's two-factor authentication

DELETE/api/v1/security/2fa/admins/{id}

Who

root

API tokens

API tokens can't use this endpoint

Operation

twoFAResetAdmin · ky call twoFAResetAdmin

Parameters

Responses

• 204 Done, no content
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: root-only
• 404 Not Found: not-found
• 409 Conflict: self
• 500 Internal Server Error: internal

#List blocked addresses

GET/api/v1/security/blocks

Who

root

API tokens

admin token area: server

Operation

bfBlocks · ky call bfBlocks

Responses

• 200 OK
  Body

  Field	Type
  items	array of BlockView

• 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

#Block an address

POST/api/v1/security/blocks

Who

root

API tokens

admin token area: server

Operation

bfBlock · ky call bfBlock

Request body

Responses

• 200 OK
  Body

  Field	Type
  items	array of BlockView

• 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

#Unblock an address

DELETE/api/v1/security/blocks/{id}

Who

root

API tokens

admin token area: server

Operation

bfUnblock · ky call bfUnblock

Parameters

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

#Get the brute force protection settings

GET/api/v1/security/brute-force

Who

root

API tokens

admin token area: server

Operation

bfGet · ky call bfGet

Responses

• 200 OK
  Body

  Field	Type
  geo	map of any
  my_country	string
  my_ip	string
  my_ip_trusted	boolean
  settings	map of any
  stats	object Field Type failures_24h integer ip_blocks integer user_locks 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

#Save the brute force protection settings

PUT/api/v1/security/brute-force

Who

root

API tokens

admin token area: server

Operation

bfPut · ky call bfPut

Request body

map of any

Responses

• 200 OK
  Body

  Field	Type
  geo	map of any
  my_country	string
  my_ip	string
  my_ip_trusted	boolean
  settings	map of any
  stats	object Field Type failures_24h integer ip_blocks integer user_locks 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

#Update the country database

POST/api/v1/security/geo/update

Who

root

API tokens

admin token area: server

Operation

geoUpdate · ky call geoUpdate

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)
• 502 Bad Gateway: geo-download

#Brute force history

GET/api/v1/security/history

Who

root

API tokens

admin token area: server

Operation

bfHistory · ky call bfHistory

Parameters

Responses

• 200 OK
  Body

  Field	Type
  attempts	array of StoreLoginAttempt
  events	array of StoreBFEvent

• 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 allowed and blocked addresses and countries

GET/api/v1/security/lists

Who

root

API tokens

admin token area: server

Operation

bfLists · ky call bfLists

Parameters

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreBFRecord
  my_country	string
  my_ip	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

#Add to the allow or block list

POST/api/v1/security/lists

Who

root

API tokens

admin token area: server

Operation

bfListAdd · ky call bfListAdd

Request body

Responses

• 201 Created
  Body

  Field	Type
  created_at always	integer
  created_by always	string
  expires_at	integer
  id always	string
  kind always	string
  list always	string
  reason	string
  value always	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

#Remove from the allow or block list

DELETE/api/v1/security/lists/{id}

Who

root

API tokens

admin token area: server

Operation

bfListDelete · ky call bfListDelete

Parameters

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: lockout
• 500 Internal Server Error: internal

#Get the security policies

GET/api/v1/security/policies

Who

root

API tokens

admin token area: server

Operation

policiesGet · ky call policiesGet

Responses

• 200 OK
  Body

  Field	Type
  my_ip	string
  password_features	array of SettingsOption
  policies	PoliciesView

• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

#Save the security policies

PUT/api/v1/security/policies

Who

root

API tokens

admin token area: server

Operation

policiesPut · ky call policiesPut

Request body

Responses

• 200 OK
  Body

  Field	Type
  my_ip	string
  password_features	array of SettingsOption
  policies	PoliciesView

• 400 Bad Request: rejected, 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

#Firewall status and open ports

GET/api/v1/server/firewall

Who

root

API tokens

admin token area: server

Operation

getServerFirewall · ky call getServerFirewall

Parameters

Responses

• 200 OK
  Body

  map of any

• 400 Bad Request: rejected
• 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

#Open or close firewall ports

PUT/api/v1/server/firewall/ports

Who

root

API tokens

admin token area: server

Operation

putServerFirewallPorts · ky call putServerFirewallPorts

Parameters

Request body

Responses

• 200 OK
  Body

  map of any

• 400 Bad Request: rejected
• 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 firewall rules

GET/api/v1/server/firewall/rules

Who

root

API tokens

admin token area: server

Operation

fwRules · ky call fwRules

Responses

• 200 OK
  Body

  Field	Type
  kernel	map of any
  lists	map of integer
  my_ip	string
  rules	array of FwRuleView
  smtp_restriction	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)
• 500 Internal Server Error: internal

#Add a firewall rule

POST/api/v1/server/firewall/rules

Who

root

API tokens

admin token area: server

Operation

fwRuleCreate · ky call fwRuleCreate

Request body

Responses

• 201 Created
  Body

  Field	Type
  action always	string
  comment	string
  created_at	integer
  enabled	boolean
  id	string
  ports	string
  position	integer
  protocol	string
  source	string

• 400 Bad Request: rejected, 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

#Delete a firewall rule

DELETE/api/v1/server/firewall/rules/{id}

Who

root

API tokens

admin token area: server

Operation

fwRuleDelete · ky call fwRuleDelete

Parameters

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: lockout
• 500 Internal Server Error: internal

#Update a firewall rule

PATCH/api/v1/server/firewall/rules/{id}

Who

root

API tokens

admin token area: server

Operation

fwRulePatch · ky call fwRulePatch

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  action always	string
  comment	string
  created_at	integer
  enabled	boolean
  id	string
  ports	string
  position	integer
  protocol	string
  source	string

• 400 Bad Request: rejected
• 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: lockout
• 500 Internal Server Error: internal