[BETA] Update DataDog external integration endpoint

PUT /dbaas-external-endpoint-datadog/{id}

Path parameters

id string(uuid) Required

application/json

Body Required

settings object

External integration DataDog configuration
Hide settings attributes Show settings attributes object
- datadog-api-key string Required
  
  Datadog API key
  
  Minimum length is 1, maximum length is 256. Format should match the following pattern: ^[A-Za-z0-9]{1,256}$.
- site string Required
  
  Datadog intake site. Defaults to datadoghq.com
  
  Values are us3.datadoghq.com, ddog-gov.com, datadoghq.eu, us5.datadoghq.com, ap1.datadoghq.com, or datadoghq.com.
- datadog-tags array[object]
  
  Custom tags provided by user
  Hide datadog-tags attributes Show datadog-tags attributes object
  
  comment string
  
  Optional tag explanation
  
  Maximum length is 1024.
  
  tag string Required
  
  Tag value
  
  Minimum length is 1, maximum length is 200.
- disable-consumer-stats boolean
  
  Disable consumer group metrics
- kafka-consumer-check-instances integer(int64)
  
  Number of separate instances to fetch kafka consumer statistics with
  
  Minimum value is 1, maximum value is 100.
- kafka-consumer-stats-timeout integer(int64)
  
  Number of seconds that datadog will wait to get consumer statistics from brokers
  
  Minimum value is 2, maximum value is 300.
- max-partition-contexts integer(int64)
  
  Maximum number of partition contexts to send
  
  Minimum value is 200, maximum value is 200000.

Responses

200 application/json

200
Hide response attributes Show response attributes object
Operation
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

PUT /dbaas-external-endpoint-datadog/{id}

curl \
 -X PUT https://api-ch-gva-2.exoscale.com/v2/dbaas-external-endpoint-datadog/{id} \
 -H "Content-Type: application/json" \
 -d '{"settings":{"datadog-api-key":"string","site":"us3.datadoghq.com","datadog-tags":[{"comment":"string","tag":"string"}],"disable-consumer-stats":true,"kafka-consumer-check-instances":42,"kafka-consumer-stats-timeout":42,"max-partition-contexts":42}}'

Request examples

{
  "settings": {
    "datadog-api-key": "string",
    "site": "us3.datadoghq.com",
    "datadog-tags": [
      {
        "comment": "string",
        "tag": "string"
      }
    ],
    "disable-consumer-stats": true,
    "kafka-consumer-check-instances": 42,
    "kafka-consumer-stats-timeout": 42,
    "max-partition-contexts": 42
  }
}

Response examples (200)

{
  "id": "string",
  "reason": "incorrect",
  "reference": {
    "id": "string",
    "link": "string",
    "command": "string"
  },
  "message": "string",
  "state": "failure"
}