Try the API in your browser
Paste your token, enter your Connect server address, and send a real request from the docs.
Endpoints
- List vaults
- Get vault details
- List items
- Add an item
- Get item details
- Replace an item
- Delete an item
- Update a subset of item attributes
- List files
- Get file details
- Get file content
- List API activity
- Check the server heartbeat
- Check server health
- Get Prometheus metrics
Requirements
Before you can use the 1Password Connect Server API, you’ll need to:- Sign up for 1Password.
- Set up a Secrets Automation workflow..
- Deploy 1Password Connect in your infrastructure.
Request headers
Each request to the API has to be authenticated with an access token. Provide it and specify the content type:Try it in the docs
Every endpoint has a Try it panel with its parameters, example requests and responses.1
Get an access token
Create a token for your Connect server. See Manage access tokens.
2
Start with a read-only call
Open Get heartbeat to check the server is up, then List vaults to see which vaults your token can read.
3
Point it at your server and paste your token
Select Try it, enter your Connect server’s address, and paste your token in the Authorization field.
4
Send it, or copy the code
Select Send to see the live response, or copy the request as cURL, Python, JavaScript, Go, and more.
The Try it panel sends requests from the docs, so it can’t reach a Connect server that only listens on localhost or a private network. In that case, copy the cURL request from the example panel and run it on a machine that can reach your server.