MOmongodb
Metric Integrations

Create One Metric Integration

Creates a new metric integration configuration identified by a unique ID.

post/api/atlas/v2/groups/{groupId}/metricIntegrations

Request

  • Base URL
    https://cloud.mongodb.com
  • URL
    https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/metricIntegrations
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://cloud.mongodb.com/api/oauth/token
    • or HTTP digest

Path parameters

groupIdstring required
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.

NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.

Query parameters

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

Request body

aggregationTemporality'DELTA' | 'CUMULATIVE' required

The temporality to send to the metric integration.

endpointstring required

OpenTelemetry collector endpoint URL. Must use HTTPS.

integrationType'OTEL' required

Type of metric integration. Identifies which protocol will be used for the integration. This value cannot be modified after the integration is created.

metricSelectionstring[] required

Array of metric categories to export. Determines which types of metrics are sent to the integration.

providerType'CUSTOM' | 'DYNATRACE' | 'NEW_RELIC' required

The provider type for the metric integration. Identifies the third-party service provider.

Example request

{
  "endpoint": "https://otel-collector.example.com:4318/v1/metrics",
  "headers": [
    {
      "name": "Authorization",
      "value": "Bearer token123"
    }
  ]
}

Response

Created

Changes

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