Skip to content

Dynatrace

Connecting to Dynatrace allows NeuBird to collect telemetry data such as service performance, environment metrics, and application health for real-time monitoring and insights.

NeuBird requires two types of authentication credentials to integrate with Dynatrace:

  • Classic API Token
  • OAuth Client (Client ID and Client Secret)

Each token serves a different purpose and must be configured correctly to enable secure communication between NeuBird and Dynatrace.

To allow NeuBird to access Dynatrace APIs, create a Classic API Token with the required scopes.

Navigate to Access Tokens in Dynatrace

  1. Log in to your Dynatrace environment.
  2. In the top search bar, type Access Tokens.
  3. Select Access Tokens from the results.
  4. Click Create new token.

Enable the following scopes:

  • problems.read
  • problems.write
  • settings.read
  • metrics.read
  • entities.read

Provide a descriptive name for the token, for example: NeuBird.

After creating the token, copy and store it securely. You will not be able to view it again.

You can also create the Classic API Token using the Dynatrace API:

Terminal window
curl -X POST "https://<your-environment-id>.live.dynatrace.com/api/v2/apiTokens" \
-H "accept: application/json; charset=utf-8" \
-H "Content-Type: application/json; charset=utf-8" \
-H "Authorization: Api-Token <YOUR_EXISTING_API_TOKEN>" \
-d '{
"name": "NeuBird",
"scopes": [
"entities.read",
"metrics.read",
"problems.read",
"problems.write",
"settings.read"
]
}'

Replace:

  • <your-environment-id> with your Dynatrace environment ID
  • <YOUR_EXISTING_API_TOKEN> with a valid token that has permission to create API tokens

Store the generated token securely.

To authorize NeuBird to access your Dynatrace data, create an OAuth client with appropriate permissions.

  1. Access Account Management: In the Dynatrace console, navigate to the bottom-left corner of the screen.

    • Click your username.
    • From the pop-up menu, select Account Management.

    Access Account Management in Dynatrace

  2. Open Identity & Access Management:

    • On the Account Management screen, click Identity & Access Management in the top navigation bar.
    • Select OAuth Clients from the list of available options.

    Open Identity and Access Management

  3. Create a New OAuth Client:

    • On the OAuth Clients screen, click the Create client button in the upper-right corner.

    Create new OAuth client

    • On the Create Client screen:
      • Enter the current user’s email address in the Subject user email field.

    Enter client details

  4. Assign Permissions: Grant the following permissions to ensure the OAuth client has the appropriate level of access.

Tip: Permissions

  • settings:objects:read — View schema settings objects.
  • app-settings:objects:read — View app settings objects.
  • environment-api:events:read — Read events.
  • environment-api:metrics:read — Read metrics.
  • environment-api:security-problems:write — Manage security problems.
  • environment-api:security-problems:read — Read security problems.
  • environment-api:problems:write — Manage problems.
  • environment-api:problems:read — Read problems.
  • environment-api:entities:read — Read entities.
  • storage:system:read — View system tables.
  • storage:bizevents:read — View business events.
  • storage:buckets:read — View Grail buckets.
  • storage:metrics:read — View metrics.
  • storage:events:read — View events.
  • storage:logs:read — View logs.
  • storage:smartscape:read — View Smartscape data.
  • storage:entities:read — View entities.
  • storage:spans:read — View spans.
  • storage:security.events:read — View security events.
  • document:documents:read — View documents.
  • Scroll to the bottom of the screen.
  • Click the Create client button.

After the client is created, make note of the following credentials:

  • Client ID
  • Client Secret
  • Login URL — for example:

Important: For NeuBird integration, you must convert the login URL into the live data endpoint.
Replace apps with live in the URL.
Example:

  • Login URL: https://bcz58691.apps.dynatrace.com
  • Live Data Endpoint: https://bcz58691.live.dynatrace.com
FieldRequiredDescription
NameYesA unique name for the connection (e.g., Dynatrace-Production-Integration)
DescriptionNoA short description of the integration’s purpose or scope
EndpointYesThe Dynatrace live data endpoint URL (e.g., https://bcz58691.live.dynatrace.com) — replace apps with live in the login URL
Client IDYesThe Client ID generated when creating the OAuth client in Dynatrace
Client SecretYesThe Client Secret associated with the Client ID

For general instructions on creating and managing connections, see the Connections Overview.