Plugins API - POST a new endpoint of a plugin

Creates a new endpoint for the specified ActiveGate plugin.

The request consumes and produces an application/json payload.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the plugin where you want to create an endpoint.	path	required
body	RemotePluginEndpoint	The JSON body of the request. Contains parameters of the new plugin endpoint.	body	optional

Request parameters JSON model

The RemotePluginEndpoint object

Configuration of a plugin endpoint.

Element	Type	Description	Required
id	string	The ID of the endpoint.	optional
pluginId	string	The ID of the plugin to which the endpoint belongs.	optional
name	string	The name of the endpoint, displayed in DESK.	optional
enabled	boolean	The endpoint is enabled (`true`) or disabled (`false`).	optional
properties	object	The list of endpoint parameters. Each parameter is a property-value pair.	optional
activeGatePluginModule	EntityShortRepresentation	The ActiveGate plugin module that hosts the endpoint.	required

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description	Required
id	string	The ID of the DESK entity.	required
name	string	The name of the DESK entity.	optional
description	string	A short description of the DESK entity.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "id": "-2183662974968812535",
  "pluginId": "custom.remote.python.demo",
  "name": "Demo endpoint",
  "enabled": true,
  "properties": {
    "serverIp": "127.0.0.1",
    "password": "",
    "username": "DESK",
    "dropdownProperty": "two"
  },
  "activeGatePluginModule": {
    "id": "-8844900174269363000"
  }
}

Response format

Response parameters JSON model

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description
id	string	The ID of the DESK entity.
name	string	The name of the DESK entity.
description	string	A short description of the DESK entity.

{}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/plugins/{id}/endpoints/validator SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/plugins/{id}/endpoints/validator

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Response code

Code	Description
204	Validated. The submitted configuration is valid. Response doesn't have a body.
400	Failed. The input is invalid.

Example

In this example, the request creates a new endpoint for the SAP plugin which has the ID of custom.remote.python.sap.

The API token is passed in the Authorization header.

Curl

curl -X POST \
  https://mySampleEnv.live.dexp.ae/api/config/v1/plugins/custom.remote.python.sap/endpoints \
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
    "pluginId": "custom.remote.python.sap",
    "name": "RESTtest",
    "enabled": false,
    "properties": {
        "clientno": "001",
        "serverIp": "127.0.0.1",
        "password": "",
        "instance": "00",
        "username": "DT"
    },
    "activeGatePluginModule": {
        "id": "1768386982494938781"
    }
}'

Request URL

https://mySampleEnv.live.dexp.ae/api/config/v1/plugins/custom.remote.python.sap/endpoints

Request body


        api-examples/config/plugin/post-plugin-endpoint.json

Download

{
  "pluginId": "custom.remote.python.sap",
  "name": "RESTtest",
  "enabled": false,
  "properties": {
    "clientno": "001",
    "serverIp": "192.168.0.1",
    "password": "",
    "instance": "00",
    "username": "DT"
  },
  "activeGatePluginModule": {
    "id": "1768386982494938781"
  }
}

Response body

{
  "id": "8757307336635955682"
}

Response code

201

Result

The new endpoint looks like this in the UI:

Plugin endpoint - new