Metrics

Update metrics integration

Changed on

Update a metrics integration configuration.

put/integrations/metrics/{integration_id}

Request

  • Base URL
    https://api.cloudamqp.com/api
  • URL
    https://api.cloudamqp.com/api/integrations/metrics/{integration_id}
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

connection_stringstring

(azure_monitor) Azure Application Insights Connection String

regionstring

(cloudwatch, cloudwatch_v2, cloudwatch_v3, datadog, datadog_v2, newrelic_v2, newrelic_v3) Region

access_key_idstring

(cloudwatch, cloudwatch_v2) AWS access key id

secret_access_keystring

(cloudwatch, cloudwatch_v2) AWS secret access key

iam_rolestring

(cloudwatch, cloudwatch_v2, cloudwatch_v3) AWS IAM role ARN

iam_external_idstring

(cloudwatch, cloudwatch_v2, cloudwatch_v3) External identifier for IAM role

auth_typestring

(prometheus_remote_write) Authentication method: none, basic_auth or headers

usernamestring

(prometheus_remote_write) Username for basic auth

passwordstring

(prometheus_remote_write) Password or token for basic auth

headersstring

(prometheus_remote_write) Headers sent with every request, one key: value pair per line

client_idstring

(prometheus_remote_write) Client ID for oauth2

client_secretstring

(prometheus_remote_write) Client secret for oauth2

token_urlstring

(prometheus_remote_write) OAuth2 token endpoint for oauth2

scopesstring

(prometheus_remote_write) Scopes requested with the oauth2 token

api_keystring

(datadog, datadog_v2, datadog_v3, librato, newrelic_v2, newrelic_v3) API key

rabbitmq_dashboard_metrics_formatboolean

(datadog_v3) Transform RabbitMQ metric names

environment_idstring

(dynatrace) Environment ID

access_tokenstring

(dynatrace) Access token

instance_idstring

(grafana) Numeric Grafana Cloud Prometheus instance ID

api_tokenstring

(grafana) Grafana Cloud API token

emailstring

(librato) Email registered at Librato

tokenstring

(splunk, splunk_v2) Authentication token

hostnamestring

(splunk) Destination hostname

portinteger

(splunk) Destination port

endpointstring

(grafana) Prometheus remote write URL, (prometheus_remote_write) Prometheus remote write URL including path, (splunk_v2) HEC destination

type'service_account'

(stackdriver, stackdriver_v2) Service account credential type. Defaults to service_account if omitted.

project_idstring

(stackdriver, stackdriver_v2) GCP project ID from the service account JSON key file

client_emailstring

(stackdriver, stackdriver_v2) Service account email address from the service account JSON key file

private_keystring textarea

(stackdriver, stackdriver_v2) Service account private key from the service account JSON key file

tagsstring

(optional for all) Tags

metrics_filterstring[]

(optional for metrics integrations) Metrics to include in the integration export. When omitted on update, the existing filter is preserved.

queue_regexstring

(optional for legacy integrations) Queue filter regex

vhost_regexstring

(optional for legacy integrations) Vhost filter regex

include_ad_queuesboolean

(optional for legacy integrations) Include auto-delete queues

Response

Integration updated successfully

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property