Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

1Password Health API

Operations for checking the health and status of the Connect server.

1Password Health API is one of 11 APIs that 1Password publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Health. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.8.1.

Requests are made against a single base URL, http://localhost:8080.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.8.1
Base URL
http://localhost:8080
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

1Password Health API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — A Connect server access token generated from 1Password. Each request must include this token in the Authorization header.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Health 2

Operations for checking the health and status of the Connect server.

GET
/heartbeat
1Password Check Server Status
getHeartbeat → 200
GET
/health
1Password Get Server Health
getHealth → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ServerHealth (3 properties). Each schema is shown below with its type and property counts.

ServerHealth
object
Represents the health status of the Connect server and its dependencies.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

1password-health-api-openapi.yml Raw ↑

Other APIs 1Password publishes across the network.

1Password Accounts API
1Password Activity API
1Password Audit Events API
1Password Files API
1Password Introspection API
1Password Item Usages API
1Password Items API
1Password Metrics API
1Password Sign-In Attempts API
1Password Vaults API