Skip to main content
POST
Create Connection

Authorizations

X-API-KEY
string
header
required

Headers

X-CONNECTION-INVITE-TOKEN
string | null

Path Parameters

organization_id
string<uuid>
required

Body

application/json
vendor
enum<string>
required

Connection vendor

Available options:
SEMGREP,
SENTINELONE_VMS,
SENTINELONE,
AIKIDO,
ORCA,
AWS_INSPECTOR2,
AWS_ACCESS_ANALYSER,
AWS_SECURITYHUB,
INSIGHTVM,
MS_DEFENDER_VMS,
MS_ENTRA,
MS_DEFENDER_VMS_GCC_HIGH,
MS_DEFENDER_CLOUD,
MS_DEFENDER_ENDPOINT,
JIRA,
QUALYS,
GITHUB,
ARNICA,
SNYK,
TANIUM_VMS,
GITLAB,
MEND,
SERVICENOW,
UPWIND,
TENABLE,
CHECKMARX,
CROWDSTRIKE_SPOTLIGHT,
CROWDSTRIKE,
BLACK_KITE,
BIT_SIGHT,
LACEWORK_CSPM,
WIZ_VMS,
WIZ_CODE,
OKTA_IDP
credentials
TenableCredentials · object
required

Connection credentials

identifier
string | null

An optional identifier for the connection, you can use this to reference the connection in your own system

options

Connection options, ONLY used for Oauth2 URL overrides for Snyk and MS Defender Endpoint

Response

Successful Response

id
string<uuid>
required
vendor
string
required
is_active
boolean
required
refresh_interval_secs
integer
required
timeout_secs
integer
required
organization_id
string<uuid>
required
state
enum<string>
required
Available options:
PENDING,
ACTIVE,
PAUSED,
DELETED
created_at
string<date-time>
required
updated_at
string<date-time>
required
health
ConnectionHealthStatus · object
required
oauth2_authorize_url
string | null
identifier
string | null