1password.local

REST API interface for 1Password Connect.

🔑 bearer 15 endpoints security
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (4 total)

onepassword-sdk-python ✓ Official
pip install onepassword-sdk-python
connect-sdk-python ✓ Official
pip install connect-sdk-python
connect-sdk-js ✓ Official
npm install connect-sdk-js
connect-sdk-go ✓ Official
go get github.com/1Password/connect-sdk-go
curl examples
Get state of the server and its dependencies.
curl \
  -H "Authorization: Bearer $API_KEY" \
  http://1password.local/health
Get all Vaults
curl \
  -H "Authorization: Bearer $API_KEY" \
  http://1password.local/vaults
Query server for exposed Prometheus metrics
curl \
  -H "Authorization: Bearer $API_KEY" \
  http://1password.local/metrics
Endpoints (15 total)
GET
/health
Get state of the server and its dependencies.
GET
/vaults
Get all Vaults
GET
/metrics
Query server for exposed Prometheus metrics
GET
/activity
Retrieve a list of API Requests that have been made.
GET
/heartbeat
Ping the server for liveness
GET
/vaults/{vaultUuid}
Get Vault details and metadata
GET
/vaults/{vaultUuid}/items
Get all items for inside a Vault
GET
/vaults/{vaultUuid}/items/{itemUuid}
Get the details of an Item
GET
/vaults/{vaultUuid}/items/{itemUuid}/files
Get all the files inside an Item
GET
/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}
Get the details of a File
GET
/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}/content
Get the content of a File
POST
/vaults/{vaultUuid}/items
Create a new Item
Language coverage
Python
2
TypeScript
1
Go
1
At a glance
Total SDKs4
Languages3
Endpoints15
Authbearer
Categories1
http://1password.local
Other 1Password APIs (1)
events