Skip to main content

Integration API endpoints

Kathyana Rule
  • Updated

Understand and create integrations

Relative URI Method Success code Description
/integrations GET 200 Get all integrations.
POST 201 Create an integration.
/integrations/<_id> GET 200 Get a specific integration.
PUT 200 Update a specific integration.
DELETE 204 Delete a specific integration.
/integrations/<_id>/clone POST 201 Clone a specific 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.
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.
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.

Related articles

Comments

0 comments

Please sign in to leave a comment.