Skip to main content
Use the Connect API to read and manage the vaults and items your Connect server can access, and to check the server’s health and activity. You need a running Connect server and an access token.

Try the API in your browser

Paste your token, enter your Connect server address, and send a real request from the docs.

Endpoints

To view the API in another tool, download the 1Password Connect API specification file (1.8.1).

Requirements

Before you can use the 1Password Connect Server API, you’ll need to:

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.

Response object models

APIRequest object

APIRequest: Actor object

APIRequest: Resource object

ErrorResponse object

Vault object

Item object

Item: Field object

Item: File object

Item: GeneratorRecipe object

The recipe is used in conjunction with the “generate” property to set the character set used to generate a new secure value.

Item: PasswordDetails object

Item: Section object

Item: URL object

Server Health object

Server Health: Dependency object