v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Entity Integration Configs

Create or update entity integration configuration

Create or replace the configuration for a given integration in the caller's organization. The shape of data.attributes.config depends on the integration:

For github: config must contain an enabled_repos array of objects with hostname, github_org_name, and repo_name.
For jira: config must contain an enabled_projects array of objects with hostname, account_id, and project_key.
For pagerduty: config must contain an accounts array of objects with a required enabled boolean and an optional subdomain string.

put/api/v2/idp/entity_integrations/{integration_id}

Path parameters

integration_idstring required

Example:github

The identifier of the integration whose configuration is being managed. Supported values are github, jira, and pagerduty.

Request body

Example request

{
  "data": {
    "attributes": {
      "config": {
        "enabled_repos": [
          {
            "github_org_name": "myorg",
            "hostname": "github.com",
            "repo_name": "myrepo"
          }
        ]
      }
    },
    "type": "entity_integration_config_requests"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "config": {
        "enabled_repos": [
          {
            "github_org_name": "myorg",
            "hostname": "github.com",
            "repo_name": "myrepo"
          }
        ]
      },
      "integration_id": "github",
      "org_id": 1234
    },
    "id": "01HJABCD12345678ABCDEFGHIJ",
    "type": "entity_integration_configs"
  }
}