API ReferenceManagementConnector Management
POST
/v1/mgmt/connector

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

id?string

The connector id, assigned by the server on create and required on update.

Lengthlength <= 254
name*string

The connector's display name.

Length1 <= length <= 254
type*string

The connector template id, such as http, which cannot change after create. LoadAllConnectorTemplates lists the available templates.

Length1 <= length <= 254
status?string

Either enabled or disabled, defaults to enabled on create. A disabled connector is not run by flows or automatic triggers; audit streaming ignores status and follows the template's auditEnabled configuration field if it has one, and is otherwise always on. While its secrets are placeholders, create a connector disabled, also set auditEnabled: false on an audit connector whose template has that field, and enable it once the real values are in.

description?string

A free text description of the connector.

Lengthlength <= 254
configuration?object

The template's configuration fields by name, as GetConnectorTemplate describes them. Checked against the template on create and update, with missing defaults filled in; not checked for messaging providers, which have no template. Secret values are returned as PLACEHOLDER_VALUE, and sending that value back keeps the stored secret.

Create a connector from a template, using a valid management key. type is the template id from LoadAllConnectorTemplates, and configuration holds the template's fields by name as GetConnectorTemplate describes them. The server checks the configuration against the template before saving it: required fields must be set, values must match their field's type, allowed options and dependencies, unknown fields are rejected, and missing fields with a default are filled in. Returns the stored connector, with secret values as PLACEHOLDER_VALUE and defaults filled in. Messaging provider types such as sendgrid, except smtp, are stored as messaging providers with ids starting with MP and are not checked, since they have no template. A connector does nothing by itself; the template's types says how it is used: a flows connector is called from a flow by the connector action with the connector's id (agents on the Descope MCP find it with GetActionCatalog, query connector), or automatically on events when the template has auto-trigger settings and they are on, and an audit connector streams audit events while its auditEnabled configuration field is true (the default), or always when the template has no such field.

curl -X POST "https://api.descope.com/v1/mgmt/connector" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "string"  }'
{  "id": "string",  "name": "string",  "type": "string",  "status": "string",  "description": "string",  "configuration": {}}
export interface Response {/** * The connector id, assigned by the server on create and required on update. */id?: string/** * The connector's display name. */name: string/** * The connector template id, such as `http`, which cannot change after create. LoadAllConnectorTemplates lists the *  available templates. */type: string/** * Either `enabled` or `disabled`, defaults to `enabled` on create. A disabled connector is not run by flows or *  automatic triggers; audit streaming ignores `status` and follows the template's `auditEnabled` configuration field *  if it has one, and is otherwise always on. While its secrets are placeholders, create a connector `disabled`, also *  set `auditEnabled: false` on an audit connector whose template has that field, and enable it once the real values *  are in. */status?: string/** * A free text description of the connector. */description?: string/** * The template's configuration fields by name, as GetConnectorTemplate describes them. Checked against the template *  on create and update, with missing defaults filled in; not checked for messaging providers, which have no template. *  Secret values are returned as `PLACEHOLDER_VALUE`, and sending that value back keeps the stored secret. */configuration?: {}}
Was this helpful?