Connectors
These endpoints need a Keycloak access token. See Authentication. For what each connector type does, see Tools and connectors.
A connector has two parts:
config: settings that are not secret, stored in the database and returned by the APIcredentials: secrets, written to Vault and never returned
List connectors
/connectorsNeeds any role on the project. Each entry has id, name, connector_type, config and project_id.
Query parameters
project_idstringrequiredCreate a connector
/connectorsWrites the credentials to Vault, then creates the connector. If Vault refuses, nothing is created. Needs the developer or admin role on the project.
Body
idstringrequirednamestringrequiredconnector_typestringrequiredsql, rest_api, mcp, graphql, salesforce, office365 or echo.project_idstringrequiredconfigobjectoptionalcredentialsobjectoptionalResponses
Fields for each type
| Type | config | credentials |
|---|---|---|
sql | dialect (postgresql, mysql, mssql or oracle), host, port (the dialect's default), database (the SID for Oracle), service_name (Oracle), schema, allowed_tables, max_rows (default 100, at most 1000), timeout_seconds (default 15, at most 60) | username, password |
mcp | url, transport (streamable_http, the default, or sse), auth, read_only_tools, disabled_tools | Depends on auth |
rest_api | base_url, auth, operations | Depends on auth, see below |
graphql | endpoint, auth, allow_mutations (default false) | Depends on auth, see below |
salesforce | auth: flow (client_credentials or password) and token_url | client_id, client_secret, and for the password flow also username, password and optionally security_token |
office365 | auth: tenant_id, and sender_mailbox for sending mail | client_id, client_secret |
echo | prefix | none |
For rest_api and graphql, auth.type is one of:
auth.type | Other auth fields | credentials |
|---|---|---|
none | none | |
api_key | header (default X-API-Key) | api_key |
bearer | token | |
oauth2_client_credentials | token_url | client_id, client_secret |
rest_api, graphql, mcp, salesforce and office365 connectors can also take user_oauth, to act as each user: {"enabled": true, "provider": "microsoft" | "google" | "salesforce" | "generic", "authorize_url", "token_url", "revoke_url", "scopes", "tenant_id"}, with oauth_client_id and oauth_client_secret in credentials (Salesforce and Microsoft 365 reuse their client_id and client_secret). SQL Server, Oracle and user_oauth need the enterprise_connectors licence feature.
An mcp connector's tools are read from the server, never written by a client. stdio servers, and any command or args, are refused.
Each rest_api operation has name, method, path and optionally description and param_schema. Path parameters go in braces, such as /invoices/{invoice_id}. In param_schema, each parameter has a type (string, number, integer, boolean, array or object), an optional description, and required, which defaults to true.
Remove a connector
/connectors/{connector_id}Deletes the connector's credentials from Vault, then the connector. Agent versions that use its tools keep the tool in their definition, but calls to it fail. Needs the developer or admin role on the project.
Responses
{"removed": "<connector_id>"}.More connector routes
| Method and path | Who | What it does |
|---|---|---|
PATCH /connectors/{connector_id} | developer or admin | Change a connector's settings. Credentials stay as they are. |
PUT /connectors/{connector_id}/credentials | developer or admin | Replace its credentials in Vault. |
POST /connectors/{connector_id}/test | developer or admin | Check the connection. |
POST /connectors/{connector_id}/tools/refresh | developer or admin | mcp: ask the server for its tools again. |
POST /connector-imports/openapi | developer or admin | {"project_id", "spec_text"} or {"project_id", "spec_url"}: read an OpenAPI 3 description and return the operations to pick, the authentication it implies and warnings. Stores nothing. A URL is fetched through the connector sandbox, without redirects, up to 5 MB. |
GET /connectors/{connector_id}/usage | viewer | Calls, errors, calls made as a user, and SQL rows, per day. |
GET /connectors/{connector_id}/grants | developer or admin | The people connected to a connector that acts as each user. |
DELETE /connectors/{connector_id}/grants/{grant_id} | developer or admin | Disconnect someone. Their token is revoked at the provider and deleted. |
Your connections
For connectors that act as each user. Each person manages their own.
| Method and path | What it does |
|---|---|
GET /me/connections | The connectors that act as each user, and whether you have connected yours. |
POST /connectors/{connector_id}/oauth/start | Start connecting your account. Returns the provider's sign-in address. |
POST /connectors/oauth/complete | Finish, from the console's callback page. |
GET /connectors/{connector_id}/oauth/grants/me | Your connection's state. |
DELETE /me/connections/{connector_id} | Disconnect. |
POST /connectors/{connector_id}/oauth/consent-links | With a project API key: {"external_id": "<your user id>"} returns a consent link for one of your application's users. |