endoflife.ai Metrics API

openapi: 3.2.0
info:
  title: Endoflife Ai Metrics API
  version: 1.4.0
  contact:
    email: partners@endoflife.ai
    url: https://endoflife.ai/api
  description: 'Operations tagged Metrics across 2 of this provider''s published API definitions: openapi.json, endoflife-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.endoflife.ai
security:
- {}
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: Metrics
paths:
  /v1/metrics:
    get:
      summary: Prometheus metrics for a stack, or for every cycle of one product
      description: One of stack or slug is required. stack pairs are slug:version (a bare slug scores its highest-risk cycle); at most 25 pairs per call (200 on a Pro key), the rest are dropped.
      parameters:
      - name: stack
        in: query
        required: false
        schema:
          type: string
        example: nodejs:18,python:3.8
      - name: slug
        in: query
        required: false
        schema:
          type: string
        example: postgresql
        description: Every cycle of this product
      responses:
        '200':
          description: Prometheus text exposition format (eol_risk_score, eol_is_eol, eol_days_until, eol_days_past, eol_risk_factor, eol_extended_support_available, eol_info, eol_scrape_success)
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-EOL-Key-Status:
              $ref: '#/components/headers/X-EOL-Key-Status'
        '400':
          description: Neither stack nor slug given
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: No valid X-API-Key, from 2026-11-16T00:00:00Z (keyless access ends then). The body says how to get a free key (https://endoflife.ai/api#free-key); X-EOL-Key-Status names why a sent key was not honoured.
          headers:
            X-EOL-Key-Status:
              $ref: '#/components/headers/X-EOL-Key-Status'
            WWW-Authenticate:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Daily quota exhausted for this tier (anonymous per IP, keyed per key). Retry-After says when the counter resets (next UTC midnight).
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-EOL-Key-Status:
              $ref: '#/components/headers/X-EOL-Key-Status'
            Retry-After:
              schema:
                type: integer
              description: Seconds until the daily counter resets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Metrics
      operationId: getV1Metrics
      x-operation-id-source: derived
    servers:
    - url: https://api.endoflife.ai
components:
  headers:
    X-RateLimit-Remaining:
      schema:
        type: integer
      description: Requests left today after this one. Absent on a Pro key.
    X-EOL-Key-Status:
      schema:
        type: string
        enum:
        - unknown
        - inactive
      description: 'Present only when an X-API-Key was sent and not honoured: unknown (no such key), inactive (subscription cancelled or refunded). Until 2026-11-16 the request was answered as anonymous; from then it is refused with 401. Free keys do not expire.'
    X-RateLimit-Reset:
      schema:
        type: integer
      description: 'Unix time (seconds) when the daily counter resets: the next UTC midnight. Absent on a Pro key.'
    X-RateLimit-Limit:
      schema:
        type: string
      description: Requests allowed per UTC day for the caller's tier (anonymous per IP; keyed per key), or the word unlimited on a Pro key.
  schemas:
    Error:
      type: object
      description: 'Every error carries error and docs. Some add detail: reason, candidates (sibling cycles of a split line), cycle and last_published (a version above an ended line''s last patch), did_you_mean (closest tracked slugs), not_tracked, see_products, tracked_products, upgrade, get_free_key, key_status, limit_bytes.'
      properties:
        error:
          type: string
        docs:
          type: string
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    BearerAuth:
      type: http
      scheme: bearer
      description: 'The same API key sent as Authorization: Bearer <key>, for clients that cannot set X-API-Key (Prometheus before 3.0).'
x-refined-from:
- openapi.json
- endoflife-ai-openapi.json