Integration API endpoints

Kathyana Queeman

Updated September 20, 2024 16:18

Relative URI	Method	Success code	Description
`/integrations`	`GET`	`200`	Get all integrations.
`/integrations`	`POST`	`201`	Create an integration.
`/integrations/<_id>`	`GET`	`200`	Get a specific integration.
	`PUT`	`200`	Update a specific integration.
	`PATCH`	`204`	Update part of a specific integration.
	`DELETE`	`204`	Delete a specific integration.
`/integrations/<_id>/clone`	`POST`	`201`	Clone a specific integration.
`/integrations/<_id>/flows`	`GET`	`200`	Get flows associated with an integration.
`/integrations/<_id>/connections`	`GET`	`200`	Get connections associated with an integration.
`/integrations/<_id>/connections/register`	`PUT`	`200`	Register multiple connections at one time to an integration.
`/integrations/<_id>/connections/<_connectionId>/register`	`PUT`	`200`	Register a connection to an integration.
`/integrations/<_id>/connections/<_connectionId>/register`	`DELETE`	`204`	Unregister a connection from an integration.
`/integrations/<_id>/exports`	`GET`	`200`	Get exports associated with an integration.
`/integrations/<_id>/imports`	`GET`	`200`	Get imports associated with an integration.
`/integrations/<_id>/ashares`	`GET`	`200`	Get users associated with an integration.
`/integrations/<_id>/revisions/create`	`POST`	`201`	Create a snapshot of a specific integration.
`/integrations/<_id>/revisions/create?ignoreIfNoChanges`	`POST`	`201`	Create a snapshot automatically, regardless of any changes to the integration. This snapshot always occurs, even if there are no changes to your integration. The ignoreIfNoChanges query parameter must be set to false.
	`POST`	`201`	Create an automated snapshot only if you make new changes to your integration. The ignoreIfNoChanges query parameter must be set to true.
	`POST`	`204`	Skip creating a snapshot when you don’t make changes. The ignoreIfNoChanges query parameter must be set to true.
`/integrations/<_id>/installSteps`	`GET`	`201`	Display Integration App installation steps per provided JSON definitions.
`/integrations/<_id>/installSteps`	`POST`	`200`	Submit form, trigger the next Integration App installation steps after user interaction or code completion.
`/integrations/<_id>/uninstallSteps`	`GET`	`200`	Display Integration App uninstallation steps per provided JSON definitions.
`/integrations/<_id>/uninstallSteps`	`POST`	`201`	Submit form, trigger the next Integration App uninstallation steps after user interaction or code completion.
`/integrations/<_id>/audit`	`GET`	`200`	Get a log for a specific integration.
`/integrations/<_id>/template`	`GET`	`200`	Download an integration.
`/integrations/<_id>/dependencies`	`GET`	`200`	Get all resources using or used by this integration.

The following fields are available to update using PATCH:

Field	Sub-field	Data type
`settings`		`mixed`
`version`		`string`
`tag`		`string`
`updateInProgress`		`boolean`
`flowGroupings[*]`	`settings`	`mixed`
`aliases`		`mixed`

Integration API examples

Register multiple connections at one time to an integration

PUT /v1/integrations/8s3••••••••5k4/connections/register HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Request body

[
  "<_connectionId>","<_connectionId>",...
]

Download an integration

Request body

POST /v1/integrations/8s3••••••••5k4/template HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample body

{
"signedURL":"https://integrator-templates.s3.amazonaws.com/8s3••••••••5k4.zip?AWSAccessKeyId=XXXXXXX&Expires=1707272837&Signature=XXXXXXXXX",
"key":"<integrationId>.zip"
}

Comments

2 comments

Tyler Lamparter
November 23, 2023 01:33 (Edited November 23, 2023 02:51)

Principal Product Manager
Adding some additional options here.

To get flows associated with an integration, use:
```
GET /integrations/<_integrationId>/flows
```
To get connections associated with an integration, use:
```
GET /integrations/<_integrationId>/connections
```
To get exports associated with an integration, use:
```
GET /integrations/<_integrationId>/exports
```
To get imports associated with an integration, use:
```
GET /integrations/<_integrationId>/imports
```
To get users associated with an integration, use:
```
GET /integrations/<_integrationId>/ashares
```
0
Tyler Lamparter
November 23, 2023 02:58 (Edited November 23, 2023 03:13)

Principal Product Manager
You can also register and unregister connections to integrations via the following:

To register a single connection to an integration, use the following api.
```
PUT /integrations/<_integrationId>/connections/<_connectionId>/register
```
To register multiple connections at one time to an integration, use the following api. The body is an array of connection ids that you want to register to the integration.
```
PUT /integrations/<_integrationId>/connections/register

[
  "<_connectionId>","<_connectionId>",...
]
```
To unregister a connection from an integration, use the following endpoint.
```
DELETE /integrations/<_integrationId>/connections/<_connectionId>/register
```
0

Please sign in to leave a comment.