HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Install an extension

Installs an extension from the extension store.

The query parameter sync=true may be provided to make this a synchronous operation. In this case, the operation produces JSON status updates during the operation using HTTP chunked transfer encoding.

The default is asynchronous operation. To check on the progress of the operation, use GET /extension/instance/{id}.

Body Params

Extension in the store

string
enum

Desired state of the extension

Allowed:
string
required

ID from the extension store

files
object

Maps extension file IDs to local content items, with ‘public:’ or ‘private:’ prefix

string

IP address to allocate to the extension, or null

string

Note to be displayed with the extension.

Responses

Language
Response
Choose an example:
application/json