Networking
List and inspect connectors for your team. Read or update connector settings and the project environments linked to each connector.
Get the connector by ID. Accepts a dashboard/team requester or a deployment's project OIDC token. Project requesters may only read connectors linked to their project and environment.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
connector | string | Yes | Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Get the configuration that connects a connector to a project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
connector | string | Yes | Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot. |
projectId | string | Yes | Edgenivo project ID. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List the projects connected to a connector and the environments where each connection is available.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
connector | string | Yes | Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot. |
limit | integer | No | Maximum number of project connections to return. Defaults to 50. Minimum: 1. Maximum: 100. |
cursor | string | No | Cursor from pagination.next on the previous response. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List connectors that belong to a team.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of connectors to return. Defaults to 20. Minimum: 1. Maximum: 100. |
cursor | string | No | Cursor from pagination.next on the previous response. |
projectId | string | No | Return only connectors connected to this project. |
search | string | No | Search connector names, UIDs, and services. |
type | string | No | Comma-separated connector types: slack, discord, github, linear, linq, salesforce, sendblue, snowflake, snowflake-wif, microsoft-entra, api-key, photon, oauth, or custom. |
service | string | No | Comma-separated provider or service identifiers. |
sort | string | No | Sort by name in ascending order, or by creation or update time in descending order. Allowed values: "name", "createdAt", "updatedAt". |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
List the connectors connected to a project and the environments where each connection is available.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | Edgenivo project ID. |
limit | integer | No | Maximum number of connector connections to return. Defaults to 50. Minimum: 1. Maximum: 100. |
cursor | string | No | Cursor from pagination.next on the previous response. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Update a connector and return the connector with any service-side update signals that the caller must handle.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
connector | string | Yes | Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | object | Yes | Connector fields to update. |
Connect a connector to a project, or replace the environments on an existing project connection.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
connector | string | Yes | Stable connector ID or URL-encoded team-scoped UID. Examples: scl_abc123 or slack%2Fmy-bot. |
projectId | string | Yes | Edgenivo project ID. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | object | Yes | Environments enabled for a connector project connection. |
Was this helpful?