Skip to main content

Integrations

44 endpoints.

`GET` /api/v1/integrations

List Integrations

Parameter	In	Required	Description
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations

Create Integration

Request body: IntegrationCreate

Responses: 200, 400, 401, 500

`GET` /api/v1/integrations/catalog

Get Integration Catalog

Parameter	In	Required	Description
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/github/oauth/complete

Complete Git Hub

Complete GitHub OAuth flow

Request body: HandleCompleteGitHubRequest

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/jira/oauth/complete

Complete Jira O Auth

Complete Jira OAuth flow

Request body: HandleCompleteJiraOAuthRequest

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/jira/oauth/reauthorize

Reauthorize Jira O Auth

Reauthorize Jira OAuth connection

Request body: HandleReauthorizeJiraOAuthRequest

Responses: 200, 400, 401, 500

`DELETE` /api/v1/integrations/{id}

Delete Integration

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`GET` /api/v1/integrations/{id}

Get Integration

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`PATCH` /api/v1/integrations/{id}

Update Integration

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: IntegrationUpdate

Responses: 200, 400, 401, 500

`PATCH` /api/v1/integrations/{id}/credentials

Rotate Integration Credentials

Replace an integration's stored API keys or secrets

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: IntegrationCredentialsUpdate

Responses: 200, 400, 401, 500

`GET` /api/v1/integrations/{id}/sync_configs

List Sync Configs

List sync configs for an integration

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/{id}/sync_configs

Create Sync Config

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: IntegrationSyncConfigCreate

Responses: 200, 400, 401, 500

`DELETE` /api/v1/integrations/{id}/sync_configs/{sync_config_id}

Delete Sync Config

Parameter	In	Required	Description
`id`	path	yes	id identifier
`sync_config_id`	path	yes	sync config id identifier

Responses: 200, 400, 401, 500

`PATCH` /api/v1/integrations/{id}/sync_configs/{sync_config_id}

Update Sync Config

Parameter	In	Required	Description
`id`	path	yes	id identifier
`sync_config_id`	path	yes	sync config id identifier

Request body: IntegrationSyncConfigUpdate

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/{provider}/oauth/start

Start O Auth

Parameter	In	Required	Description
`provider`	path	yes	provider identifier

Request body: HandleStartOAuthRequest

Responses: 200, 400, 401, 500

Jira

`GET` /api/v1/jira/stats

Get Jira Stats

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/tickets

List Jira Tickets

Parameter	In	Required	Description
`integration_id`	query	yes	Jira integration ID
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`POST` /api/v1/jira/tickets

Create Jira Ticket

Request body: JiraTicketCreate

Responses: 200, 400, 401, 500

`POST` /api/v1/jira/tickets/bulk

Bulk Create Jira Tickets

Request body: JiraTicketBulkCreate

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/tickets/by-finding/{id}

Get Jira Ticket By Finding

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/tickets/{id}

Get Jira Ticket

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`PATCH` /api/v1/jira/tickets/{id}

Update Jira Ticket

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: JiraTicketUpdate

Responses: 200, 400, 401, 500

`POST` /api/v1/jira/tickets/{id}/attachments

Upload Attachment

Upload an attachment to a Jira ticket

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body required.

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/priorities

List Jira Priorities

Parameter	In	Required	Description
`id`	path	yes	id identifier
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/projects

List Jira Projects

Parameter	In	Required	Description
`id`	path	yes	id identifier
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/projects/{project_key}

Get Jira Project

Parameter	In	Required	Description
`id`	path	yes	id identifier
`project_key`	path	yes	project key identifier

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/projects/{project_key}/statuses

List Jira Project Statuses

Parameter	In	Required	Description
`id`	path	yes	id identifier
`project_key`	path	yes	project key identifier

Responses: 200, 400, 401, 500

`POST` /api/v1/jira/{id}/search

Search Jira Issues

Search Jira issues via JQL

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: JiraSearchRequest

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/service-desks

List Service Desks

Parameter	In	Required	Description
`id`	path	yes	id identifier
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/service-desks/{service_desk_id}/request-types

List Request Types

Parameter	In	Required	Description
`id`	path	yes	id identifier
`service_desk_id`	path	yes	service desk id identifier
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/statuses

List Jira Statuses

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

Jira / Ticket Rules

`GET` /api/v1/jira/{id}/ticket-rules

List Ticket Rules

Parameter	In	Required	Description
`id`	path	yes	id identifier
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`POST` /api/v1/jira/{id}/ticket-rules

Create Ticket Rule

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: JiraTicketRuleCreate

Responses: 200, 400, 401, 500

`DELETE` /api/v1/jira/{id}/ticket-rules/{rule_id}

Delete Ticket Rule

Parameter	In	Required	Description
`id`	path	yes	id identifier
`rule_id`	path	yes	rule id identifier

Responses: 200, 400, 401, 500

`GET` /api/v1/jira/{id}/ticket-rules/{rule_id}

Get Ticket Rule

Parameter	In	Required	Description
`id`	path	yes	id identifier
`rule_id`	path	yes	rule id identifier

Responses: 200, 400, 401, 500

`PATCH` /api/v1/jira/{id}/ticket-rules/{rule_id}

Update Ticket Rule

Parameter	In	Required	Description
`id`	path	yes	id identifier
`rule_id`	path	yes	rule id identifier

Request body: JiraTicketRuleUpdate

Responses: 200, 400, 401, 500

Jira / Incident Tickets

`GET` /api/v1/jira/tickets/by-incident/{id}

Get Ticket By Incident

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`POST` /api/v1/security-operations/monitor/soc/incidents/{id}/jira-ticket

Create Incident Ticket

Create a Jira ticket for an incident

Parameter	In	Required	Description
`id`	path	yes	id identifier

Request body: JiraIncidentTicketCreate

Responses: 200, 400, 401, 500

API Keys

`GET` /api/v1/integrations/api-keys

List Api Keys

Parameter	In	Required	Description
`paginateFrom`	query	no	Pagination offset (0-based)
`paginateSize`	query	no	Items per page

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/api-keys

Create Api Key

Request body: HandleCreateApiKeyRequest

Responses: 200, 400, 401, 500

`DELETE` /api/v1/integrations/api-keys/{id}

Delete Api Key

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`GET` /api/v1/integrations/api-keys/{id}

Get Api Key

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`PATCH` /api/v1/integrations/api-keys/{id}

Disable Api Key

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

`POST` /api/v1/integrations/api-keys/{id}/regenerate

Regenerate Api Key Secret

Parameter	In	Required	Description
`id`	path	yes	id identifier

Responses: 200, 400, 401, 500

GET /api/v1/integrations
POST /api/v1/integrations
GET /api/v1/integrations/catalog
POST /api/v1/integrations/github/oauth/complete
POST /api/v1/integrations/jira/oauth/complete
POST /api/v1/integrations/jira/oauth/reauthorize
DELETE /api/v1/integrations/{id}
GET /api/v1/integrations/{id}
PATCH /api/v1/integrations/{id}
PATCH /api/v1/integrations/{id}/credentials
GET /api/v1/integrations/{id}/sync_configs
POST /api/v1/integrations/{id}/sync_configs
DELETE /api/v1/integrations/{id}/sync_configs/{sync_config_id}
PATCH /api/v1/integrations/{id}/sync_configs/{sync_config_id}
POST /api/v1/integrations/{provider}/oauth/start
Jira
Jira / Ticket Rules
Jira / Incident Tickets
- GET /api/v1/jira/tickets/by-incident/{id}
- POST /api/v1/security-operations/monitor/soc/incidents/{id}/jira-ticket
API Keys