Prometheus

opencollection: 1.0.0
info:
  name: Prometheus Pushgateway API
  version: v1.9.0
items:
- info:
    name: Metrics
    type: folder
  items:
  - info:
      name: Prometheus Add or update metrics for a job
      type: http
    http:
      method: POST
      url: http://{host}:{port}/metrics/job/:job
      params:
      - name: job
        value: ''
        type: path
        description: The job label value for this metric group. This is the primary grouping key for pushed metrics.
    docs: Adds new metrics for the specified job or updates existing metrics. Unlike PUT, POST only updates the metrics that
      are present in the request body while leaving other metrics in the group untouched.
  - info:
      name: Prometheus Replace all metrics for a job
      type: http
    http:
      method: PUT
      url: http://{host}:{port}/metrics/job/:job
      params:
      - name: job
        value: ''
        type: path
        description: The job label value for this metric group. This is the primary grouping key for pushed metrics.
    docs: Replaces all metrics for the specified job with the metrics in the request body. The entire group of metrics for
      the job is atomically replaced. Use PUT when you want to fully overwrite the existing metric set for a job.
  - info:
      name: Prometheus Delete all metrics for a job
      type: http
    http:
      method: DELETE
      url: http://{host}:{port}/metrics/job/:job
      params:
      - name: job
        value: ''
        type: path
        description: The job label value for this metric group. This is the primary grouping key for pushed metrics.
    docs: Deletes all metrics for the specified job from the Pushgateway. After deletion, Prometheus will no longer scrape
      any metrics for this job label combination.
  - info:
      name: Prometheus Add or update metrics for a job with grouping labels
      type: http
    http:
      method: POST
      url: http://{host}:{port}/metrics/job/:job/:labels
      params:
      - name: job
        value: ''
        type: path
        description: The job label value for this metric group. This is the primary grouping key for pushed metrics.
      - name: labels
        value: ''
        type: path
        description: Additional grouping labels as alternating label-name/label-value path segments (e.g., instance/host1/datacenter/eu).
    docs: Adds or updates metrics for the specified job and grouping label combination. Only metrics included in the request
      body are changed; other metrics in the group are preserved.
  - info:
      name: Prometheus Replace metrics for a job with grouping labels
      type: http
    http:
      method: PUT
      url: http://{host}:{port}/metrics/job/:job/:labels
      params:
      - name: job
        value: ''
        type: path
        description: The job label value for this metric group. This is the primary grouping key for pushed metrics.
      - name: labels
        value: ''
        type: path
        description: Additional grouping labels as alternating label-name/label-value path segments (e.g., instance/host1/datacenter/eu).
    docs: Replaces all metrics for the specified job and grouping label combination. Grouping labels are additional key-value
      pairs appended to the path as alternating label name and value segments (e.g., /metrics/job/myjob/instance/myinstance).
  - info:
      name: Prometheus Delete metrics for a job with grouping labels
      type: http
    http:
      method: DELETE
      url: http://{host}:{port}/metrics/job/:job/:labels
      params:
      - name: job
        value: ''
        type: path
        description: The job label value for this metric group. This is the primary grouping key for pushed metrics.
      - name: labels
        value: ''
        type: path
        description: Additional grouping labels as alternating label-name/label-value path segments (e.g., instance/host1/datacenter/eu).
    docs: Deletes all metrics for the specified job and grouping label combination. Only metrics with the exact label set
      specified in the path are deleted.
  - info:
      name: Prometheus List all pushed metrics
      type: http
    http:
      method: GET
      url: http://{host}:{port}/api/v1/metrics
    docs: Returns all currently stored metric families in JSON format, grouped by job and grouping labels. This endpoint provides
      a structured view of all metrics available for Prometheus to scrape.
- info:
    name: Status
    type: folder
  items:
  - info:
      name: Prometheus Health check
      type: http
    http:
      method: GET
      url: http://{host}:{port}/-/healthy
    docs: Returns 200 if the Pushgateway is healthy and ready to accept pushed metrics. Used for liveness probes in Kubernetes
      deployments.
  - info:
      name: Prometheus Readiness check
      type: http
    http:
      method: GET
      url: http://{host}:{port}/-/ready
    docs: Returns 200 when the Pushgateway is ready to serve traffic. Used for readiness probes in Kubernetes deployments.
  - info:
      name: Prometheus Get Pushgateway status
      type: http
    http:
      method: GET
      url: http://{host}:{port}/api/v1/status
    docs: Returns build information and runtime status for the Pushgateway server including version, revision, and configuration
      flags.
bundled: true