APIHub
Back to Explore

1Password Connect

The 1Password Connect REST API lets you manage and query 1Password vaults, including retrieving vault lists, accessing and creating, updating, or deleting items and their attached files, and also provides endpoints for health checks, activity logs, and server metrics.

Security
bearer
No HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

772ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/activity

Retrieve a list of API Requests that have been made.

  • limit (query, limit) — How many API Events should be retrieved in a single request.
  • offset (query, offset) — How far into the collection of API Events should the response start
GET

/health

Get state of the server and its dependencies.

GET

/heartbeat

Ping the server for liveness

GET

/metrics

Query server for exposed Prometheus metrics

GET

/vaults

Get all Vaults

  • filter (query) — Filter the Vault collection based on Vault name using SCIM eq filter
GET

/vaults/{vaultUuid}

Get Vault details and metadata

  • vaultUuid (path, required) — The UUID of the Vault to fetch Items from
GET

/vaults/{vaultUuid}/items

Get all items for inside a Vault

  • vaultUuid (path, required) — The UUID of the Vault to fetch Items from
  • filter (query) — Filter the Item collection based on Item name using SCIM eq filter
POST

/vaults/{vaultUuid}/items

Create a new Item

  • vaultUuid (path, required) — The UUID of the Vault to create an Item in
DELETE

/vaults/{vaultUuid}/items/{itemUuid}

Delete an Item

  • vaultUuid (path, required) — The UUID of the Vault the item is in
  • itemUuid (path, required) — The UUID of the Item to update
GET

/vaults/{vaultUuid}/items/{itemUuid}

Get the details of an Item

  • vaultUuid (path, required) — The UUID of the Vault to fetch Item from
  • itemUuid (path, required) — The UUID of the Item to fetch
PATCH

/vaults/{vaultUuid}/items/{itemUuid}

Update a subset of Item attributes

  • vaultUuid (path, required) — The UUID of the Vault the item is in
  • itemUuid (path, required) — The UUID of the Item to update
PUT

/vaults/{vaultUuid}/items/{itemUuid}

Update an Item

  • vaultUuid (path, required) — The UUID of the Item's Vault
  • itemUuid (path, required) — The UUID of the Item to update
GET

/vaults/{vaultUuid}/items/{itemUuid}/files

Get all the files inside an Item

  • vaultUuid (path, required) — The UUID of the Vault to fetch Items from
  • itemUuid (path, required) — The UUID of the Item to fetch files from
  • inline_files (query) — Tells server to return the base64-encoded file contents in the response.
GET

/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}

Get the details of a File

  • vaultUuid (path, required) — The UUID of the Vault to fetch Item from
  • itemUuid (path, required) — The UUID of the Item to fetch File from
  • fileUuid (path, required) — The UUID of the File to fetch
  • inline_files (query) — Tells server to return the base64-encoded file contents in the response.
GET

/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content

Get the content of a File

15 endpoints auto-detected

Authentication

This API uses Bearer token authentication — pass your token in the Authorization header.

curl -X GET \
  "http://1password.local/activity" \
  -H "Authorization: Bearer YOUR_TOKEN"

1password.local · HTTPS only