TRtrycompai
Integrations

Update an integration connection

Changed on

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

patch/v1/integrations/connections/{id}

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Request body

organizationIdstring

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

metadataobject

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 request

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

Changes