Skip to content
Start here

Integrations

List integrations
GET/accounts/{account_id}/one/integrations
Get integration details
GET/accounts/{account_id}/one/integrations/{id}
Create integration
POST/accounts/{account_id}/one/integrations
Update integration
PATCH/accounts/{account_id}/one/integrations/{id}
Delete integration
DELETE/accounts/{account_id}/one/integrations/{id}
Pause integration
POST/accounts/{account_id}/one/integrations/{id}/pause
Resume integration
POST/accounts/{account_id}/one/integrations/{id}/resume
ModelsExpand Collapse
IntegrationListResponse object { id, application, created, 4 more }

Serializer for v2 integration list responses.

id: string

Integration ID.

formatuuid
application: map[string]
created: string

When the integration was created.

formatdate-time
is_paused: boolean

Whether the user paused the integration.

name: string

Name of the integration.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
IntegrationGetResponse object { id, application, auth_method, 12 more }

The requested item.

id: string

Integration ID.

formatuuid
application: map[string]
auth_method: map[string]

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: array of string

DLP Profiles enabled for the integration.

health_details: array of map[unknown]

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: array of map[unknown]

Use cases enabled for the integration.

IntegrationCreateResponse object { id, application, auth_method, 12 more }

The requested item.

id: string

Integration ID.

formatuuid
application: map[string]
auth_method: map[string]

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: array of string

DLP Profiles enabled for the integration.

health_details: array of map[unknown]

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: array of map[unknown]

Use cases enabled for the integration.

IntegrationUpdateResponse object { id, application, auth_method, 12 more }

The requested item.

id: string

Integration ID.

formatuuid
application: map[string]
auth_method: map[string]

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: array of string

DLP Profiles enabled for the integration.

health_details: array of map[unknown]

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: array of map[unknown]

Use cases enabled for the integration.

IntegrationPauseResponse object { id, application, auth_method, 12 more }

The requested item.

id: string

Integration ID.

formatuuid
application: map[string]
auth_method: map[string]

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: array of string

DLP Profiles enabled for the integration.

health_details: array of map[unknown]

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: array of map[unknown]

Use cases enabled for the integration.

IntegrationResumeResponse object { id, application, auth_method, 12 more }

The requested item.

id: string

Integration ID.

formatuuid
application: map[string]
auth_method: map[string]

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: array of string

DLP Profiles enabled for the integration.

health_details: array of map[unknown]

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: array of map[unknown]

Use cases enabled for the integration.