Update an integration connection | Comp AI API

Update an integration connection in Comp AI. Connect vendor systems, configure OAuth apps, run compliance checks, sync employees, manage variables.

PATCH /v1/integrations/connections/{id}

Update an integration connection

cURL

curl --request PATCH \
  --url https://api.trycomp.ai/v1/integrations/connections/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "organizationId": "<string>",
  "metadata": {
    "connectionName": "Production AWS (renamed)",
    "regions": [
      "us-east-1",
      "us-west-2"
    ]
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    organizationId: '<string>',
    metadata: {
      connectionName: 'Production AWS (renamed)',
      regions: ['us-east-1', 'us-west-2']
    }
  })
};

fetch('https://api.trycomp.ai/v1/integrations/connections/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/integrations/connections/{id}"

payload = {
    "organizationId": "<string>",
    "metadata": {
        "connectionName": "Production AWS (renamed)",
        "regions": ["us-east-1", "us-west-2"]
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Body

application/json

organizationId · string

Auto-resolved from your API key / session. You can omit this; it is ignored by the server.

metadata · object

Connection metadata to merge into the existing record. Common AWS keys: connectionName, regions (string array), awsScanMode ('comp_scanners' or 'security_hub'). The server shallow-merges this with the existing metadata, so include only the keys you want to change.

Example:

{
  "connectionName": "Production AWS (renamed)",
  "regions": ["us-east-1", "us-west-2"]
}

Response

200 - undefined