Resellers

#Make the account a reseller, or stop

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

Who

root

API tokens

admin token area: accounts

Operation

setMakeReseller · ky call setMakeReseller

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  bw_exceeded always	boolean
  bw_limit_mb	integer
  bw_used_month_mb always	integer
  cgi always	boolean
  contact_email always	string
  created_at always	integer
  db_count always	integer
  db_prefix always	string
  db_used_bytes always	integer
  default_email_quota_mb	integer
  disk_quota_mb	integer
  disk_used_mb always	integer
  feature_list_id always	string
  home_dir always	string
  id always	string
  inodes_limit	integer
  inodes_used always	integer
  ip_address always	string
  ip_id always	string
  is_reseller always	boolean
  locale always	string
  main_domain always	string
  make_reseller always	boolean
  max_addon	integer
  max_email	integer
  max_email_per_hour	integer
  max_email_quota_mb	integer
  max_ftp	integer
  max_parked	integer
  max_sql	integer
  max_sub	integer
  owner_id always	string
  owner_name always	string
  package_id always	string
  package_name always	string
  php_max_children	integer
  shell always	string
  status always	string
  suspend_locked always	boolean
  suspend_reason always	string
  suspended_at	integer
  suspended_by	string
  theme always	string
  uid always	integer
  username 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
• 409 Conflict: validation
• 500 Internal Server Error: internal

#Reseller privilege catalog

GET/api/v1/acl-keys

Who

root

API tokens

admin token area: server

Operation

aclKeys · ky call aclKeys

Responses

• 200 OK
  Body

  Field	Type
  items	array of ACLKey

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

#List privilege lists

GET/api/v1/acl-lists

Who

root

API tokens

admin token area: server

Operation

listACLLists · ky call listACLLists

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreACLList
  keys	array of ACLKey

• 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

#Create a privilege list

POST/api/v1/acl-lists

Who

root

API tokens

admin token area: server

Operation

postAclLists · ky call postAclLists

Request body

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 privilege list

DELETE/api/v1/acl-lists/{lid}

Who

root

API tokens

admin token area: server

Operation

deleteACLList · ky call deleteACLList

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

#Update a privilege list

PUT/api/v1/acl-lists/{lid}

Who

root

API tokens

admin token area: server

Operation

putAclListsLid · ky call putAclListsLid

Parameters

Request body

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

#Your reseller overview

GET/api/v1/reseller

Is the signed-in reseller's overview: limits, usage, nameservers and privileges.

Who

root, reseller

API tokens

admin token area: server

Operation

resellerSelf · ky call resellerSelf

Responses

• 200 OK
  Body

  Field	Type
  acl	array of string
  effective_nameservers	array of string
  privileges	array of ACLKey
  reseller	StoreReseller

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

#Reset your reseller branding

DELETE/api/v1/reseller/branding

Who

root, reseller (ACL: branding)

API tokens

admin token area: server

Operation

deleteBrandingOwn · ky call deleteBrandingOwn

Responses

• 200 OK
• 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 your reseller branding

GET/api/v1/reseller/branding

Who

root, reseller (ACL: branding)

API tokens

admin token area: server

Operation

getBrandingOwn · ky call getBrandingOwn

Responses

• 200 OK
  Body

  Field	Type
  colors	BrandingColors
  custom	boolean
  defaults always	object Field Type colors always BrandingColors product_name always string
  favicon always	string
  favicon_url	string
  links	array of BrandingLink
  logo_dark_svg	string
  logo_svg	string
  product_name	string
  public_contact	BrandingContact
  scope always	string
  updated_at	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 your reseller branding

PUT/api/v1/reseller/branding

Who

root, reseller (ACL: branding)

API tokens

admin token area: server

Operation

putBrandingOwn · ky call putBrandingOwn

Request body

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

#List resellers

GET/api/v1/resellers

Who

root

API tokens

admin token area: server

Operation

listResellers · ky call listResellers

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreReseller

• 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

#Make an account a reseller

POST/api/v1/resellers

Grants reseller status to an existing account ("Make an account a reseller").

Who

root

API tokens

admin token area: server

Operation

createReseller · ky call createReseller

Request body

Responses

• 201 Created
  Body

  Field	Type
  account_status always	string
  acl_list_id always	string
  acl_list_name always	string
  bw_limit_mb	integer
  contact_email always	string
  created_at always	integer
  disk_limit_mb	integer
  id always	string
  main_domain always	string
  max_accounts	integer
  nameservers always	array of string
  oversell_bw always	boolean
  oversell_disk always	boolean
  owns_itself always	boolean
  panel_hostname always	string
  suspend_reason	string
  suspended_at	integer
  usage always	StoreResellerUsage
  username 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)
• 409 Conflict: already-reseller, not-ready, validation
• 500 Internal Server Error: internal

#Remove reseller status

DELETE/api/v1/resellers/{id}

Takes reseller status away; the account keeps its hosting, its accounts and packages pass to root.

Who

root

API tokens

admin token area: server

Operation

removeReseller · ky call removeReseller

Parameters

Responses

• 200 OK
  Body

  Field	Type
  accounts_moved	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)
• 404 Not Found: not-found
• 500 Internal Server Error: internal

#Get a reseller

GET/api/v1/resellers/{id}

Who

root

API tokens

admin token area: server

Operation

getReseller · ky call getReseller

Parameters

Responses

• 200 OK
  Body

  Field	Type
  account_status always	string
  acl_list_id always	string
  acl_list_name always	string
  bw_limit_mb	integer
  contact_email always	string
  created_at always	integer
  disk_limit_mb	integer
  id always	string
  main_domain always	string
  max_accounts	integer
  nameservers always	array of string
  oversell_bw always	boolean
  oversell_disk always	boolean
  owns_itself always	boolean
  panel_hostname always	string
  suspend_reason	string
  suspended_at	integer
  usage always	StoreResellerUsage
  username 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

#Update a reseller's limits and privileges

PUT/api/v1/resellers/{id}

Who

root

API tokens

admin token area: server

Operation

updateReseller · ky call updateReseller

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  account_status always	string
  acl_list_id always	string
  acl_list_name always	string
  bw_limit_mb	integer
  contact_email always	string
  created_at always	integer
  disk_limit_mb	integer
  id always	string
  main_domain always	string
  max_accounts	integer
  nameservers always	array of string
  oversell_bw always	boolean
  oversell_disk always	boolean
  owns_itself always	boolean
  panel_hostname always	string
  suspend_reason	string
  suspended_at	integer
  usage always	StoreResellerUsage
  username 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)
• 404 Not Found: not-found
• 409 Conflict: validation
• 500 Internal Server Error: internal

#List a reseller's accounts

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

Who

root

API tokens

admin token area: server

Operation

resellerAccounts · ky call resellerAccounts

Parameters

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreAccount

• 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

#Reset a reseller's branding

DELETE/api/v1/resellers/{id}/branding

Who

root

API tokens

admin token area: server

Operation

deleteBrandingForReseller · ky call deleteBrandingForReseller

Parameters

Responses

• 200 OK
• 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 reseller's branding

GET/api/v1/resellers/{id}/branding

Who

root

API tokens

admin token area: server

Operation

getBrandingForReseller · ky call getBrandingForReseller

Parameters

Responses

• 200 OK
  Body

  Field	Type
  colors	BrandingColors
  custom	boolean
  defaults always	object Field Type colors always BrandingColors product_name always string
  favicon always	string
  favicon_url	string
  links	array of BrandingLink
  logo_dark_svg	string
  logo_svg	string
  product_name	string
  public_contact	BrandingContact
  scope always	string
  updated_at	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 a reseller's branding

PUT/api/v1/resellers/{id}/branding

Who

root

API tokens

admin token area: server

Operation

putBrandingForReseller · ky call putBrandingForReseller

Parameters

Request body

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

#See Ky Admin as a reseller

POST/api/v1/resellers/{id}/login-as

Makes root's session show Ky Admin as the reseller sees it, until /auth/act-as/exit.

Who

root

API tokens

API tokens can't use this endpoint

Operation

actAsReseller · ky call actAsReseller

Parameters

Responses

• 200 OK
  Body

  Field	Type
  redirect	string

• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: session-only
• 404 Not Found: not-found
• 500 Internal Server Error: internal

#Suspend a reseller and its accounts

POST/api/v1/resellers/{id}/suspend

Who

root

API tokens

admin token area: server

Operation

suspendReseller · ky call suspendReseller

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  accounts_suspended	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)
• 404 Not Found: not-found
• 409 Conflict: already-suspended
• 500 Internal Server Error: internal

#Terminate a reseller and its accounts

POST/api/v1/resellers/{id}/terminate

Removes the reseller's accounts, its packages and the reseller's own account.

Who

root

API tokens

admin token area: server

Operation

terminateReseller · ky call terminateReseller

Parameters

Responses

• 202 Accepted (runs in the background)
  Body

  Field	Type
  job_ids	array of 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
• 500 Internal Server Error: internal

#Unsuspend a reseller and its accounts

POST/api/v1/resellers/{id}/unsuspend

Who

root

API tokens

admin token area: server

Operation

unsuspendReseller · ky call unsuspendReseller

Parameters

Responses

• 200 OK
  Body

  Field	Type
  accounts_unsuspended	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)
• 404 Not Found: not-found
• 500 Internal Server Error: internal