Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
196 lines (121 loc) · 5.94 KB

IntegrationsApi.md

File metadata and controls

196 lines (121 loc) · 5.94 KB
Raw

IntegrationsApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteIntegrationSubscription DELETE /integrations/{integrationKey}/{integrationId} Delete an integration subscription by ID.
getIntegrationSubscription GET /integrations/{integrationKey}/{integrationId} Get a single integration subscription by ID.
getIntegrationSubscriptions GET /integrations/{integrationKey} Get a list of all configured integrations of a given kind.
getIntegrations GET /integrations Get a list of all configured audit log event integrations associated with this account.
patchIntegrationSubscription PATCH /integrations/{integrationKey}/{integrationId} Modify an integration subscription by ID.
postIntegrationSubscription POST /integrations/{integrationKey} Create a new integration subscription of a given kind.

deleteIntegrationSubscription

Delete an integration subscription by ID.

Example

 deleteIntegrationSubscription integrationKey=value integrationId=value

Parameters

Name Type Description Notes
integrationKey string The key used to specify the integration kind.
integrationId string The integration ID.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIntegrationSubscription

Get a single integration subscription by ID.

Example

 getIntegrationSubscription integrationKey=value integrationId=value

Parameters

Name Type Description Notes
integrationKey string The key used to specify the integration kind.
integrationId string The integration ID.

Return type

IntegrationSubscription

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIntegrationSubscriptions

Get a list of all configured integrations of a given kind.

Example

 getIntegrationSubscriptions integrationKey=value

Parameters

Name Type Description Notes
integrationKey string The key used to specify the integration kind.

Return type

Integration

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getIntegrations

Get a list of all configured audit log event integrations associated with this account.

Example

 getIntegrations

Parameters

This endpoint does not need any parameter.

Return type

Integrations

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchIntegrationSubscription

Modify an integration subscription by ID.

Example

 patchIntegrationSubscription integrationKey=value integrationId=value

Parameters

Name Type Description Notes
integrationKey string The key used to specify the integration kind.
integrationId string The integration ID.
patchDelta array[PatchOperation] Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

Return type

IntegrationSubscription

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postIntegrationSubscription

Create a new integration subscription of a given kind.

Example

 postIntegrationSubscription integrationKey=value

Parameters

Name Type Description Notes
integrationKey string The key used to specify the integration kind.
subscriptionBody SubscriptionBody Create a new integration subscription.

Return type

IntegrationSubscription

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]