Datadog Integration

Set a Datadog integration's API keys

Replaces the integration's entire set of API keys in one atomic write. Existing keys are referenced by id (kept or rotated), new keys carry only a value, and omitted keys are removed; one key is marked as the send key used to write data back to Datadog. If any key is rejected the existing set is left unchanged. All keys are accepted for inbound telemetry. Requires the organization to have multiple Datadog API keys enabled. Adding, removing, relabeling, or rotating a key other than the send key is allowed while the integration's pipeline is running; a change that affects the send key (which key it is, or its value) requires the pipeline to be stopped, since that key is baked into the running Flink job.

put/v1/integrations/datadog/{id}/api-keys

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header GREPR-API-KEY
    • or OpenID Connect (https://grepr-prod.us.auth0.com/.well-known/openid-configuration)

Path parameters

idstring required

Request body

Example request

{
  "keys": [
    {
      "keyId": "k_7f3a"
    }
  ]
}

Response

API keys updated successfully

createdAtstring date-time required

Timestamp when the integration was created.

idstring required

The integration id

jobIdsstring[] required

List of job IDs associated with the integration.

namestring required

Name of the integration.

organizationIdstring required

Organization ID of the integration.

teamIdsstring[]

The team IDs that this integration is associated with.

type'datadog' required

The type of the integration. This is used to determine the payload type.

updatedAtstring date-time required

Timestamp when the integration was last updated.

versioninteger required

Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.

Example response

{
  "name": "my_integration",
  "payload": {
    "additionalTags": [
      "tag1:value1",
      "tag2:value2"
    ],
    "apiKey": "**************ey",
    "apiKeys": [
      {
        "keyId": "k_7f3a",
        "maskedValue": "**************a1"
      }
    ],
    "appKey": "**************ey",
    "clientToken": "************EN",
    "dashboardFreshnessWindow": "PT20.345S",
    "filterQuery": "service:my-service",
    "sendKeyId": "k_7f3a",
    "site": "datadoghq.com",
    "validateKeysOnSave": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.