v56

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014121451.1 MB

Integrations

Create integration connection

Create an integration connection so Comp AI can collect evidence, run checks, or sync data from a connected provider.

post/v1/integrations/connections

Request body

organizationIdstring

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

providerSlugstring required

Provider slug for the integration. Call list-providers first to see the available slugs (e.g. 'aws', 'gcp', 'azure', 'github').

credentialsobject

Provider-specific credential fields. Keys differ by provider — call get-provider-details for the exact shape. For AWS (Cloud Tests) the fields are: connectionName (display name), awsType ('aws-commercial' or 'aws-govcloud'), roleArn (auditor role), externalId (typically your org id), regions (string array), and optionally remediationRoleArn and awsScanMode ('comp_scanners' or 'security_hub'). Omit credentials for OAuth providers — use POST /v1/integrations/oauth/start instead.

Example request

{
  "providerSlug": "aws",
  "credentials": {
    "connectionName": "Production AWS",
    "awsType": "aws-commercial",
    "roleArn": "arn:aws:iam::123456789012:role/CompAI-Auditor",
    "externalId": "org_abc123",
    "regions": [
      "us-east-1",
      "us-west-2"
    ],
    "remediationRoleArn": "arn:aws:iam::123456789012:role/CompAI-Remediator",
    "awsScanMode": "comp_scanners"
  }
}