1Password Metrics API

Operations for retrieving Prometheus-style metrics from the Connect server.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

1password-metrics-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: 1Password Connect Server Accounts Metrics API
  description: The 1Password Connect Server API provides secure access to 1Password items and vaults in your company's apps and cloud infrastructure through a private REST API. Connect Servers bridge the gap between 1Password and your infrastructure by enabling programmatic access to secrets stored in shared vaults. You can create, read, update, and delete items, manage vaults, and retrieve files attached to items.
  version: 1.8.1
  contact:
    name: 1Password Support
    url: https://support.1password.com/
  termsOfService: https://1password.com/legal/terms-of-service/
  license:
    name: MIT
    url: https://github.com/1Password/connect/blob/main/LICENSE
servers:
- url: http://localhost:8080
  description: Local Connect Server (default port 8080)
security:
- bearerAuth: []
tags:
- name: Metrics
  description: Operations for retrieving Prometheus-style metrics from the Connect server.
paths:
  /metrics:
    get:
      operationId: getMetrics
      summary: 1Password Get Server Metrics
      description: Returns Prometheus-compatible metrics about the Connect server including request counts, latencies, and resource usage.
      tags:
      - Metrics
      security: []
      responses:
        '200':
          description: Successfully retrieved metrics
          content:
            text/plain:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: A Connect server access token generated from 1Password. Each request must include this token in the Authorization header.
externalDocs:
  description: 1Password Connect Server API Reference
  url: https://developer.1password.com/docs/connect/api-reference/