Skip to main content
POST
/
v1
/
integrations
/
connections
Create integration connection
curl --request POST \
  --url https://api.trycomp.ai/v1/integrations/connections \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "providerSlug": "aws"
}
'

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Body

application/json
​
providerSlug
string
required

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

Example:

"aws"

​
organizationId
string

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

​
credentials
object

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:
{
  "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"
}

Response

201 - undefined