API Reference

Update a connector

View Markdown

PUT /api/connectors/{id}

Update a connector

Operation IDupdateConnector

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

4 properties

namestring

typestring

configobject

Additional properties are allowed.

descriptionstring

Success response body

200Connector updated

Connector updated

Content typeapplication/json

responseobject

7 properties

idinteger

namestring

typestring

configobject

Parsed connector configuration

descriptionstring | null

Nullable: yes

created_atstring · date-time

updated_atstring · date-time

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "type": "string",
  "config": {},
  "description": "string"
}'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "type": "string",
    "config": {},
    "description": "string"
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);