Google Cloud Monitoring Projects API

openapi: 3.1.0
info:
  title: Google Cloud Monitoring Projects API
  description: The Cloud Monitoring API provides programmatic access to time series data, alert policies, notification channels, uptime checks, dashboards, metric descriptors, monitored resource descriptors, and service level objectives for comprehensive infrastructure and application monitoring.
  version: v3
  contact:
    name: Google Cloud
    url: https://cloud.google.com/monitoring
servers:
- url: https://monitoring.googleapis.com
tags:
- name: Projects
paths:
  /v3/projects/{projectId}/timeSeries:
    get:
      operationId: listTimeSeries
      summary: Google Cloud Monitoring List Time Series
      description: Lists time series that match a filter.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        schema:
          type: string
        description: Monitoring filter specifying the time series to return.
      - name: interval.startTime
        in: query
        schema:
          type: string
          format: date-time
      - name: interval.endTime
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTimeSeriesResponse'
      tags:
      - Projects
    post:
      operationId: createTimeSeries
      summary: Google Cloud Monitoring Create Time Series
      description: Creates or adds data to one or more time series.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTimeSeriesRequest'
      responses:
        '200':
          description: Successful response
      tags:
      - Projects
  /v3/projects/{projectId}/alertPolicies:
    get:
      operationId: listAlertPolicies
      summary: Google Cloud Monitoring List Alert Policies
      description: Lists the existing alerting policies for the project.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAlertPoliciesResponse'
      tags:
      - Projects
    post:
      operationId: createAlertPolicy
      summary: Google Cloud Monitoring Create Alert Policy
      description: Creates a new alerting policy.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertPolicy'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPolicy'
      tags:
      - Projects
  /v3/projects/{projectId}/alertPolicies/{alertPolicyId}:
    get:
      operationId: getAlertPolicy
      summary: Google Cloud Monitoring Get Alert Policy
      description: Gets a single alerting policy.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: alertPolicyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPolicy'
      tags:
      - Projects
    patch:
      operationId: updateAlertPolicy
      summary: Google Cloud Monitoring Update Alert Policy
      description: Updates an alerting policy.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: alertPolicyId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertPolicy'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPolicy'
      tags:
      - Projects
    delete:
      operationId: deleteAlertPolicy
      summary: Google Cloud Monitoring Delete Alert Policy
      description: Deletes an alerting policy.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: alertPolicyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
      tags:
      - Projects
  /v3/projects/{projectId}/uptimeCheckConfigs:
    get:
      operationId: listUptimeCheckConfigs
      summary: Google Cloud Monitoring List Uptime Check Configs
      description: Lists the existing uptime check configurations.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUptimeCheckConfigsResponse'
      tags:
      - Projects
    post:
      operationId: createUptimeCheckConfig
      summary: Google Cloud Monitoring Create Uptime Check Config
      description: Creates a new uptime check configuration.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UptimeCheckConfig'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UptimeCheckConfig'
      tags:
      - Projects
  /v3/projects/{projectId}/notificationChannels:
    get:
      operationId: listNotificationChannels
      summary: Google Cloud Monitoring List Notification Channels
      description: Lists the notification channels for the project.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotificationChannelsResponse'
      tags:
      - Projects
    post:
      operationId: createNotificationChannel
      summary: Google Cloud Monitoring Create Notification Channel
      description: Creates a new notification channel.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannel'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationChannel'
      tags:
      - Projects
  /v3/projects/{projectId}/metricDescriptors:
    get:
      operationId: listMetricDescriptors
      summary: Google Cloud Monitoring List Metric Descriptors
      description: Lists metric descriptors that match a filter.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMetricDescriptorsResponse'
      tags:
      - Projects
    post:
      operationId: createMetricDescriptor
      summary: Google Cloud Monitoring Create Metric Descriptor
      description: Creates a new metric descriptor for custom metrics.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricDescriptor'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricDescriptor'
      tags:
      - Projects
  /v3/projects/{projectId}/groups:
    get:
      operationId: listGroups
      summary: Google Cloud Monitoring List Groups
      description: Lists the existing groups for the project.
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGroupsResponse'
      tags:
      - Projects
components:
  schemas:
    ListMetricDescriptorsResponse:
      type: object
      properties:
        metricDescriptors:
          type: array
          items:
            $ref: '#/components/schemas/MetricDescriptor'
        nextPageToken:
          type: string
    AlertPolicy:
      type: object
      description: A policy for generating alerts.
      properties:
        name:
          type: string
        displayName:
          type: string
        documentation:
          type: object
          properties:
            content:
              type: string
            mimeType:
              type: string
        conditions:
          type: array
          items:
            type: object
        combiner:
          type: string
          enum:
          - AND
          - OR
          - AND_WITH_MATCHING_RESOURCE
        enabled:
          type: boolean
        notificationChannels:
          type: array
          items:
            type: string
    CreateTimeSeriesRequest:
      type: object
      properties:
        timeSeries:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeries'
    MetricDescriptor:
      type: object
      description: Defines a metric type and its schema.
      properties:
        name:
          type: string
        type:
          type: string
        displayName:
          type: string
        description:
          type: string
        metricKind:
          type: string
          enum:
          - GAUGE
          - DELTA
          - CUMULATIVE
        valueType:
          type: string
          enum:
          - BOOL
          - INT64
          - DOUBLE
          - STRING
          - DISTRIBUTION
        unit:
          type: string
        labels:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              valueType:
                type: string
              description:
                type: string
    ListNotificationChannelsResponse:
      type: object
      properties:
        notificationChannels:
          type: array
          items:
            $ref: '#/components/schemas/NotificationChannel'
        nextPageToken:
          type: string
    ListUptimeCheckConfigsResponse:
      type: object
      properties:
        uptimeCheckConfigs:
          type: array
          items:
            $ref: '#/components/schemas/UptimeCheckConfig'
        nextPageToken:
          type: string
    ListAlertPoliciesResponse:
      type: object
      properties:
        alertPolicies:
          type: array
          items:
            $ref: '#/components/schemas/AlertPolicy'
        nextPageToken:
          type: string
    TimeSeries:
      type: object
      description: A collection of data points for a metric.
      properties:
        metric:
          type: object
          properties:
            type:
              type: string
            labels:
              type: object
              additionalProperties:
                type: string
        resource:
          type: object
          properties:
            type:
              type: string
            labels:
              type: object
              additionalProperties:
                type: string
        metricKind:
          type: string
          enum:
          - GAUGE
          - DELTA
          - CUMULATIVE
        valueType:
          type: string
          enum:
          - BOOL
          - INT64
          - DOUBLE
          - STRING
          - DISTRIBUTION
        points:
          type: array
          items:
            $ref: '#/components/schemas/Point'
    UptimeCheckConfig:
      type: object
      description: Configuration for an uptime check.
      properties:
        name:
          type: string
        displayName:
          type: string
        period:
          type: string
        timeout:
          type: string
        httpCheck:
          type: object
          properties:
            path:
              type: string
            port:
              type: integer
            useSsl:
              type: boolean
        monitoredResource:
          type: object
          properties:
            type:
              type: string
            labels:
              type: object
              additionalProperties:
                type: string
    Point:
      type: object
      properties:
        interval:
          type: object
          properties:
            startTime:
              type: string
              format: date-time
            endTime:
              type: string
              format: date-time
        value:
          type: object
          properties:
            boolValue:
              type: boolean
            int64Value:
              type: string
            doubleValue:
              type: number
            stringValue:
              type: string
    NotificationChannel:
      type: object
      description: A notification channel for alerting.
      properties:
        name:
          type: string
        type:
          type: string
        displayName:
          type: string
        labels:
          type: object
          additionalProperties:
            type: string
        enabled:
          type: boolean
    ListGroupsResponse:
      type: object
      properties:
        group:
          type: array
          items:
            type: object
        nextPageToken:
          type: string
    ListTimeSeriesResponse:
      type: object
      properties:
        timeSeries:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeries'
        nextPageToken:
          type: string
externalDocs:
  description: Google Cloud Monitoring Documentation
  url: https://cloud.google.com/monitoring/docs