DX
Visualize DX teams, users, and software catalog entities, map team ownership of services and domains, and monitor your developer experience platform through queries and alerts.
- Installation
- Authorization
- Data Model
- Types
- Release Notes
Installation
You will need a DX API key to configure this integration. API keys are generated in the DX admin area.
Required API scopes:
snapshots:read— Access to snapshots, teams, and userscatalog:read— Access to software catalog entities
See DX API documentation for more information.
To install the DX integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select DX. Click New Instance to begin configuring your integration.
Creating an instance requires the following:
-
The Account Name used to identify the DX account in JupiterOne. Ingested entities will have this value stored in
tag.AccountNamewhen theAccountNametoggle is enabled. -
Description to assist in identifying the integration instance, if desired.
-
Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as
DISABLEDand manually execute the integration. -
Your DX API Key generated from the DX admin area.
Click Create once all values are provided to finalize the integration.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
OAuth Scopes
OAuth scopes that must be granted to the application or service principal.
Show OAuth Scopes (2)
catalog:readsnapshots:read
Endpoints
API endpoints that the integration makes requests to.
Show Endpoints (5)
https://api.getdx.com/catalog.entities.infohttps://api.getdx.com/catalog.entities.listhttps://api.getdx.com/snapshots.listhttps://api.getdx.com/teams.infohttps://api.getdx.com/teams.list
Documentation Links
Links to provider documentation relevant to setup and configuration.
Show Documentation Links (5)
Per-Step Breakdown
Detailed authorization requirements for each ingestion step.
Show all steps (1)
| Step | OAuth Scopes | Endpoints |
|---|---|---|
| Fetch Catalog Entities | catalog:read | https://api.getdx.com/catalog.entities.list, https://api.getdx.com/catalog.entities.info |
Entities
The following entities are created:
| Resources | Entity _type | Entity _class |
|---|---|---|
| Account | dx_account | Account |
| CatalogDomain | dx_catalog_domain | Group |
| CatalogEntity | dx_catalog_entity | CodeModule |
| CatalogService | dx_catalog_service | Service |
| Team | dx_team | Team |
| User | dx_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
|---|---|---|
dx_account | HAS | dx_team |
dx_account | HAS | dx_user |
dx_team | HAS | dx_team |
dx_team | HAS | dx_user |
dx_team | OWNS | dx_catalog_entity |
dx_team | OWNS | dx_catalog_service |
dx_team | OWNS | dx_catalog_domain |
dx_user | MANAGES | dx_team |
Mapped Relationships
The following mapped relationships are created:
Source Entity _type | Relationship _class | Target Entity _type | Direction |
|---|---|---|---|
dx_catalog_domain | HAS | github_repo | FORWARD |
dx_catalog_entity | HAS | github_repo | FORWARD |
dx_catalog_service | HAS | github_repo | FORWARD |
Dx Account
dx_account inherits from Account
Dx Catalog Domain
dx_catalog_domain inherits from Group
| Property | Type | Description | Specifications |
|---|---|---|---|
catalogEntityType * | string | null | The type of catalog entity (e.g. service, domain) | |
githubRepoIds * | array | null | Identifiers of the GitHub repositories linked to this catalog entity | |
githubRepoNames * | array | null | Full names of the GitHub repositories linked to this catalog entity | |
ownerTeamIds * | array | null | IDs of the teams that own this catalog entity | |
ownerTeamNames * | array | null | Names of the teams that own this catalog entity |
Dx Catalog Entity
dx_catalog_entity inherits from CodeModule
| Property | Type | Description | Specifications |
|---|---|---|---|
catalogEntityType * | string | null | The type of catalog entity (e.g. service, domain) | |
githubRepoIds * | array | null | Identifiers of the GitHub repositories linked to this catalog entity | |
githubRepoNames * | array | null | Full names of the GitHub repositories linked to this catalog entity | |
ownerTeamIds * | array | null | IDs of the teams that own this catalog entity | |
ownerTeamNames * | array | null | Names of the teams that own this catalog entity |
Dx Catalog Service
dx_catalog_service inherits from Service
| Property | Type | Description | Specifications |
|---|---|---|---|
catalogEntityType * | string | null | The type of catalog entity (e.g. service, domain) | |
githubRepoIds * | array | null | Identifiers of the GitHub repositories linked to this catalog entity | |
githubRepoNames * | array | null | Full names of the GitHub repositories linked to this catalog entity | |
ownerTeamIds * | array | null | IDs of the teams that own this catalog entity | |
ownerTeamNames * | array | null | Names of the teams that own this catalog entity |
Dx Team
dx_team inherits from Team
| Property | Type | Description | Specifications |
|---|---|---|---|
ancestors * | array | null | ||
contributorCount | number | ||
isParent | boolean | ||
managerId * | string | null | ||
parentId * | string | null | ||
referenceId * | string | null |
Dx User
dx_user inherits from User
| Property | Type | Description | Specifications |
|---|---|---|---|
githubUsername * | string | null | ||
isDeveloper * | boolean | null | ||
timezone * | string | null |
Release Notes
- 2026-04-09 — New DX integration: ingests teams, users, and catalog entities including services and domains, with team ownership relationships.