Packages

#Features the account can use

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

Returns the features the account gets (and the catalog), for the customer panel and admins.

Who

root, reseller (ACL: list-accts); customer

API tokens

admin token area: accounts; account token area: features

Operation

accountFeatures · ky call accountFeatures

Parameters

Responses

• 200 OK
  Body

  Field	Type
  catalog	array of FeaturesFeature
  enabled	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

#List feature lists

GET/api/v1/feature-lists

Who

root, reseller (ACL: add-pkg or edit-pkg)

API tokens

admin token area: server

Operation

listFeatureLists · ky call listFeatureLists

Responses

• 200 OK
  Body

  Field	Type
  items	array of StoreFeatureList

• 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 feature list

POST/api/v1/feature-lists

Who

root

API tokens

admin token area: server

Operation

createFeatureList · ky call createFeatureList

Request body

Responses

• 201 Created
  Body

  Field	Type
  accounts always	integer
  created_at always	integer
  id always	string
  kind always	string
  name always	string
  off always	array of string
  owner_id always	string
  packages always	integer
  updated_at always	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)
• 409 Conflict: validation
• 500 Internal Server Error: internal

#Delete a feature list

DELETE/api/v1/feature-lists/{id}

Who

root

API tokens

admin token area: server

Operation

deleteFeatureList · ky call deleteFeatureList

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

#Get a feature list

GET/api/v1/feature-lists/{id}

Who

root

API tokens

admin token area: server

Operation

getFeatureList · ky call getFeatureList

Parameters

Responses

• 200 OK
  Body

  Field	Type
  accounts always	integer
  created_at always	integer
  id always	string
  kind always	string
  name always	string
  off always	array of string
  owner_id always	string
  packages always	integer
  updated_at always	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

#Save a feature list

PUT/api/v1/feature-lists/{id}

Replaces the list's switched-off features. Takes effect on the next customer request (the customer panel re-reads its session within a minute).

Who

root

API tokens

admin token area: server

Operation

updateFeatureList · ky call updateFeatureList

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  accounts always	integer
  created_at always	integer
  id always	string
  kind always	string
  name always	string
  off always	array of string
  owner_id always	string
  packages always	integer
  updated_at always	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
• 500 Internal Server Error: internal

#Feature catalog

GET/api/v1/features

Who

root, reseller (ACL: add-pkg or edit-pkg)

API tokens

admin token area: server

Operation

featureCatalog · ky call featureCatalog

Responses

• 200 OK
  Body

  Field	Type
  items	array of FeaturesFeature

• 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 packages

GET/api/v1/packages

Who

root, reseller (ACL: create-acct or upgrade-acct or add-pkg or edit-pkg)

API tokens

admin token area: packages

Operation

listPackages · ky call listPackages

Responses

• 200 OK
  Body

  Field	Type
  items	array of StorePackage

• 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 package

POST/api/v1/packages

Who

root, reseller (ACL: add-pkg)

API tokens

admin token area: packages

Operation

createPackage · ky call createPackage

Request body

Responses

• 201 Created
  Body

  Field	Type
  account_count always	integer
  bw_limit_mb	integer
  cgi always	boolean
  created_at always	integer
  dedicated_ip always	boolean
  default_email_quota_mb	integer
  digest_auth always	boolean
  disk_quota_mb	integer
  feature_list_id always	string
  feature_list_name always	string
  id always	string
  isolation always	StoreIsolation
  locale always	string
  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
  name always	string
  owner always	string
  owner_id always	string
  php_max_children	integer
  shell always	string
  theme always	string
  updated_at always	integer

• 400 Bad Request: validation
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: package-privileges
• 409 Conflict: validation
• 500 Internal Server Error: internal

#Options for the package editor

GET/api/v1/packages-options

Returns what the package editor offers: themes, languages, the assignable feature lists, whether CGI can run on this server and whether the signed-in admin may set unlimited values.

Who

root, reseller (ACL: add-pkg or edit-pkg)

API tokens

admin token area: server

Operation

packageOptions · ky call packageOptions

Responses

• 200 OK
  Body

  Field	Type
  can_set_unlimited	map of boolean
  cgi_available	boolean
  feature_lists	array of map of string
  locales	array of map of string
  shells	array of map of any
  themes	array of 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)
• 500 Internal Server Error: internal

#Delete a package

DELETE/api/v1/packages/{id}

Deletes a package. A package in use needs ?move_to=<package id>: its accounts move there first (taking all of that package's settings), in the same request.

Who

root, reseller (ACL: edit-pkg)

API tokens

admin token area: packages

Operation

deletePackage · ky call deletePackage

Parameters

Responses

• 200 OK
  Body

  Field	Type
  job_ids	array of string
  moved	array of string
  over_limit	array of map of any

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

#Get a package

GET/api/v1/packages/{id}

Who

root, reseller (ACL: create-acct or upgrade-acct or add-pkg or edit-pkg)

API tokens

admin token area: packages

Operation

getPackage · ky call getPackage

Parameters

Responses

• 200 OK
  Body

  Field	Type
  account_count always	integer
  bw_limit_mb	integer
  cgi always	boolean
  created_at always	integer
  dedicated_ip always	boolean
  default_email_quota_mb	integer
  digest_auth always	boolean
  disk_quota_mb	integer
  feature_list_id always	string
  feature_list_name always	string
  id always	string
  isolation always	StoreIsolation
  locale always	string
  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
  name always	string
  owner always	string
  owner_id always	string
  php_max_children	integer
  shell always	string
  theme always	string
  updated_at always	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

#Update a package and its accounts

PUT/api/v1/packages/{id}

Saves the package, copies what changed to every account on it (same transaction) and queues the job that applies it on the system. The answer lists the accounts now over a lower limit.

Who

root, reseller (ACL: edit-pkg)

API tokens

admin token area: packages

Operation

updatePackage · ky call updatePackage

Parameters

Request body

Responses

• 200 OK
  Body

  Field	Type
  accounts	integer
  changed	array of string
  job_id	string
  over_limit	array of map of any
  package	StorePackage

• 400 Bad Request: validation
• 401 Unauthorized: no session, or an invalid or expired token
• 403 Forbidden: package-privileges
• 404 Not Found: not-found
• 500 Internal Server Error: internal