Plugin Management

Create new plugin

POST

http://localhost:3000/api/plugins

Uploads a plugin file along with metadata to register a new plugin in the system.

Create new plugin

curl -X POST 'http://localhost:3000/api/plugins' \
  --form-string 'name=string' \
  --form-string 'description=string' \
  --form-string 'type=DESKTOP' \
  --form-string 'status=ACTIVE' \
  --form-string 'isActive=false' \
  --form-string 'categoryId=string' \
  --form-string 'author=string' \
  --form-string 'license=string' \
  --form-string 'homepage=string' \
  --form-string 'repository=string' \
  --form-string 'tags=string' \
  --form-string 'requiresSubscription=false' \
  --form-string 'uploadedById=string' \
  --form-string 'subscriptionPlans=string'

const form = new FormData();
form.append('name', 'string');
form.append('description', 'string');
form.append('type', 'DESKTOP');
form.append('status', 'ACTIVE');
form.append('isActive', 'false');
form.append('categoryId', 'string');
form.append('author', 'string');
form.append('license', 'string');
form.append('homepage', 'string');
form.append('repository', 'string');
form.append('tags', 'string');
form.append('requiresSubscription', 'false');
form.append('uploadedById', 'string');
form.append('subscriptionPlans', 'string');
const response = await fetch('http://localhost:3000/api/plugins', {
  method: 'POST',
  headers: {},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('name', (None, 'string')),
        ('description', (None, 'string')),
        ('type', (None, 'DESKTOP')),
        ('status', (None, 'ACTIVE')),
        ('isActive', (None, 'false')),
        ('categoryId', (None, 'string')),
        ('author', (None, 'string')),
        ('license', (None, 'string')),
        ('homepage', (None, 'string')),
        ('repository', (None, 'string')),
        ('tags', (None, 'string')),
        ('requiresSubscription', (None, 'false')),
        ('uploadedById', (None, 'string')),
        ('subscriptionPlans', (None, 'string')),
    ]
    response = requests.request('POST', 'http://localhost:3000/api/plugins', headers={}, files=files)
    print(response.text)

Request Body

{
  "name": "string",
  "description": "string",
  "type": "DESKTOP",
  "status": "ACTIVE",
  "isActive": false,
  "categoryId": "string",
  "author": "string",
  "license": "string",
  "homepage": "string",
  "repository": "string",
  "tags": [
    "string"
  ],
  "requiresSubscription": false,
  "uploadedById": "string",
  "subscriptionPlans": [
    "string"
  ]
}

201

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": false,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "name": "string",
  "description": "string",
  "type": "DESKTOP",
  "status": "ACTIVE",
  "categoryId": "string",
  "category": {},
  "versions": [
    "string"
  ],
  "author": "string",
  "license": "string",
  "homepage": "string",
  "repository": "string",
  "uploadedBy": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "thirdPartyId": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phoneNumber": "string",
    "username": "string",
    "timeZone": "string",
    "timeFormat": 12,
    "hash": "string",
    "refreshToken": "string",
    "imageUrl": "string",
    "preferredLanguage": "en",
    "preferredComponentLayout": "CARDS_GRID",
    "uiPreferences": {},
    "code": "string",
    "codeExpireAt": "2024-01-15T09:30:00Z",
    "emailVerifiedAt": "2024-01-15T09:30:00Z",
    "lastLoginAt": "2024-01-15T09:30:00Z",
    "emailToken": "string",
    "roleId": "string",
    "imageId": "string",
    "defaultTeamId": "string",
    "lastTeamId": "string",
    "defaultOrganizationId": "string",
    "lastOrganizationId": "string"
  },
  "uploadedAt": "2024-01-15T09:30:00Z",
  "requiresSubscription": false,
  "isFeatured": false,
  "isVerified": false,
  "lastDownloadedAt": "2024-01-15T09:30:00Z",
  "pluginTenants": [
    "string"
  ],
  "settings": [
    "string"
  ],
  "subscriptions": [
    "string"
  ],
  "subscriptionPlans": [
    "string"
  ],
  "pluginTags": [
    "string"
  ]
}

Body

multipart/form-data

Plugin metadata and file

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

isActivebooleanfalse

Plugin is active or not

categoryIdstring

Plugin category ID

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

tagsArray<string>

Plugin tags

requiresSubscriptionbooleanfalse

Whether plugin requires subscription

uploadedByIdstring

ID of user who uploaded the plugin

subscriptionPlansArray<string>

Subscription plans for the plugin

Response

201CreatedPlugin_1

Plugin created successfully.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

400Bad Request

Invalid input provided. Check the response body for error details.

401Unauthorized

Unauthorized access.

Authorization

api_key

Bearer

Stack Overflow Website Demo