> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ReadGcpMetricsIntegration



## OpenAPI

````yaml openapi/api_v1_config_openapi3_DOCUMENTATION_ONLY.json GET /api/v1/config/gcp-metrics-integrations/{slug}
openapi: 3.0.3
info:
  description: >

    The Config API provides standard HTTP/JSON REST endpoints for creating,
    reading,

    updating, deleting, and listing configurable Chronosphere resources.


    Use this link to download the raw Swagger specification:

    <a href="/api/v1/config/swagger.json">/api/v1/config/swagger.json</a>
  title: Config V1 API
  version: v1
servers:
  - url: https://{tenant}.chronosphere.io
    variables:
      tenant:
        default: tenant
        description: tenant ID assigned by the service provider
security:
  - ApiKeyAuth: []
tags:
  - name: ConfigV1
paths:
  /api/v1/config/gcp-metrics-integrations/{slug}:
    get:
      tags:
        - GcpMetricsIntegration
      operationId: ReadGcpMetricsIntegration
      parameters:
        - description: The unique slug that identifies the GcpMetricsIntegration to read.
          in: path
          name: slug
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1ReadGcpMetricsIntegrationResponse'
          description: A successful response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: >-
            Cannot read the GcpMetricsIntegration because the slug does not
            exist.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
components:
  schemas:
    configv1ReadGcpMetricsIntegrationResponse:
      properties:
        gcp_metrics_integration:
          $ref: '#/components/schemas/configv1GcpMetricsIntegration'
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    genericError:
      additionalProperties: true
      type: object
    configv1GcpMetricsIntegration:
      properties:
        created_at:
          description: >-
            Timestamp of when the GcpMetricsIntegration was created. Cannot be
            set by clients.
          format: date-time
          readOnly: true
          type: string
        metric_groups:
          description: An array of metric groups to be ingested for this integration.
          items:
            $ref: '#/components/schemas/GcpMetricsIntegrationMetricGroup'
          type: array
        name:
          description: >-
            The name of the GcpMetricsIntegration. You can modify this value
            after the GcpMetricsIntegration is created.
          type: string
        service_account:
          allOf:
            - $ref: '#/components/schemas/configv1GcpMetricsIntegrationServiceAccount'
          description: The Google Cloud service account to use for API authentication.
        slug:
          description: >-
            The unique identifier of the GcpMetricsIntegration. If a `slug`
            isn't provided, one is generated based on the `name` field. You
            can't modify this field after the GcpMetricsIntegration is created.
          type: string
        updated_at:
          description: >-
            Timestamp of when the GcpMetricsIntegration was last updated. Cannot
            be set by clients.
          format: date-time
          readOnly: true
          type: string
      required:
        - name
      type: object
    GcpMetricsIntegrationMetricGroup:
      properties:
        filters:
          description: >-
            Rollup rules to apply server-side aggregations to metrics in this
            group.
          items:
            $ref: '#/components/schemas/configv1GcpMetricsIntegrationFilter'
          type: array
        prefixes:
          description: |-
            A list of Google Cloud metric prefixes to ingest.

            Filters to apply to metrics in this group.
          items:
            type: string
          type: array
        project_id:
          description: The Google Cloud project ID that can access the metric data.
          type: string
        rollup_rules:
          items:
            $ref: '#/components/schemas/configv1GcpMetricsIntegrationRollupRule'
          type: array
      type: object
    configv1GcpMetricsIntegrationServiceAccount:
      properties:
        client_email:
          description: >-
            The email address of the Google Cloud service account to impersonate
            for authentication.
          type: string
      type: object
    configv1GcpMetricsIntegrationFilter:
      description: Defines a filter to apply to metrics.
      properties:
        context:
          allOf:
            - $ref: '#/components/schemas/GcpMetricsIntegrationLabelContext'
          description: >-
            Specifies the scope of the label, such as `resource.labels` or
            `metric.labels`.
        name:
          description: Label name to filter on.
          type: string
        value_glob:
          description: >-
            Value pattern using glob syntax, such as `"prod-*"` or
            `"us-east-?"`.

            If a glob pattern isn't specified, an exact match is applied.
          type: string
      type: object
    configv1GcpMetricsIntegrationRollupRule:
      description: Defines server-side aggregation rules for metrics.
      properties:
        aggregation:
          allOf:
            - $ref: '#/components/schemas/configv1GcpMetricsIntegrationAggregation'
          description: Aggregation method to use for cross-series aggregation.
        label_policy:
          allOf:
            - $ref: '#/components/schemas/GcpMetricsIntegrationRollupRuleLabelPolicy'
          description: Specifies which labels to preserve during aggregation.
        metric_name:
          description: >-
            Metric name to apply the aggregation to, such as
            `"cloudsql.googleapis.com/database/uptime"`.
          type: string
      type: object
    GcpMetricsIntegrationLabelContext:
      description: >-
        LabelContext represents the scope of a label in GCP (used for filters
        and aggregations).

         - RESOURCE_LABELS: Scopes labels to resources.
         - METRIC_LABELS: Scopes labels to metrics.
         - METADATA_SYSTEM_LABELS: Scopes labels to system metadata.
         - METADATA_USER_LABELS: Scopes labels to user metadata.
      enum:
        - RESOURCE_LABELS
        - METRIC_LABELS
        - METADATA_SYSTEM_LABELS
        - METADATA_USER_LABELS
      type: string
    configv1GcpMetricsIntegrationAggregation:
      description: Specifies the cross-series aggregation method.
      enum:
        - MEAN
        - MIN
        - MAX
        - SUM
        - COUNT
      type: string
    GcpMetricsIntegrationRollupRuleLabelPolicy:
      description: Specifies which labels to preserve during aggregation.
      properties:
        keep:
          description: Labels to keep during aggregation.
          items:
            $ref: '#/components/schemas/GcpMetricsIntegrationRollupRuleLabel'
          type: array
      type: object
    GcpMetricsIntegrationRollupRuleLabel:
      description: Specifies a label to keep during aggregation.
      properties:
        context:
          allOf:
            - $ref: '#/components/schemas/GcpMetricsIntegrationLabelContext'
          description: >-
            Specifies the scope of the label, such as `resource.labels` or
            `metric.labels`.
        name:
          description: Name of the label.
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey

````