Plugin Installation

Install a plugin with a specific version

POST

http://localhost:3000/api/plugins/{pluginId}/installations

Creates a new plugin installation for the current tenant. Requires a valid subscription for the plugin.

curl -X POST 'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/installations' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "pluginId": "550e8400-e29b-41d4-a716-446655440000",
  "versionId": "550e8400-e29b-41d4-a716-446655440000"
}'

const body = `{
  "pluginId": "550e8400-e29b-41d4-a716-446655440000",
  "versionId": "550e8400-e29b-41d4-a716-446655440000"
}`;

const response = await fetch('http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/installations', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "pluginId": "550e8400-e29b-41d4-a716-446655440000",
  "versionId": "550e8400-e29b-41d4-a716-446655440000"
}'''

response = requests.post(
    'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000/installations',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "pluginId": "550e8400-e29b-41d4-a716-446655440000",
  "versionId": "550e8400-e29b-41d4-a716-446655440000"
}

Body

application/json

pluginIdstringrequired

Unique identifier of the plugin

Example

550e8400-e29b-41d4-a716-446655440000

versionIdstringrequired

Unique identifier of the version to install

Example

550e8400-e29b-41d4-a716-446655440000

Parameters

pluginIdstringrequiredpath

Unique identifier of the plugin

Response

201Created

Plugin installation created successfully

400Bad Request

Invalid plugin ID or version ID

403Forbidden

Valid subscription required or insufficient permissions

Stack Overflow Website Demo