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.
Admin: update documentationGET
/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 startGET
/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 filterGET
/vaults/{vaultUuid}
Get Vault details and metadata
vaultUuid ( path , required ) — The UUID of the Vault to fetch Items fromGET
/vaults/{vaultUuid}/items
Get all items for inside a Vault
vaultUuid ( path , required ) — The UUID of the Vault to fetch Items fromfilter ( query ) — Filter the Item collection based on Item name using SCIM eq filterPOST
/vaults/{vaultUuid}/items
Create a new Item
vaultUuid ( path , required ) — The UUID of the Vault to create an Item inDELETE
/vaults/{vaultUuid}/items/{itemUuid}
Delete an Item
vaultUuid ( path , required ) — The UUID of the Vault the item is initemUuid ( path , required ) — The UUID of the Item to updateGET
/vaults/{vaultUuid}/items/{itemUuid}
Get the details of an Item
vaultUuid ( path , required ) — The UUID of the Vault to fetch Item fromitemUuid ( path , required ) — The UUID of the Item to fetchPATCH
/vaults/{vaultUuid}/items/{itemUuid}
Update a subset of Item attributes
vaultUuid ( path , required ) — The UUID of the Vault the item is initemUuid ( path , required ) — The UUID of the Item to updatePUT
/vaults/{vaultUuid}/items/{itemUuid}
Update an Item
vaultUuid ( path , required ) — The UUID of the Item's VaultitemUuid ( path , required ) — The UUID of the Item to updateGET
/vaults/{vaultUuid}/items/{itemUuid}/files
Get all the files inside an Item
vaultUuid ( path , required ) — The UUID of the Vault to fetch Items fromitemUuid ( path , required ) — The UUID of the Item to fetch files frominline_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 fromitemUuid ( path , required ) — The UUID of the Item to fetch File fromfileUuid ( path , required ) — The UUID of the File to fetchinline_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