1Password Connect API

by 1password.local

Bearer tokenHTTPSSecurity

Overview

REST API interface for 1Password Connect.

1Password Connect is a security API from 1password.local. Requests are authenticated with a bearer token. It is served over HTTPS. Its OpenAPI description documents 15 endpoints.

At a glance

Authentication: Bearer token
HTTPS: Yes
CORS: Unknown
Category: Security
Base URL: http://1password.local
Version: 1.5.7
Endpoints: 15
OpenAPI: Specification ↗
Spec updated: 2023-02-27

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

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

JavaScript

const response = await fetch("http://1password.local/activity", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "http://1password.local/activity",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/activity`	Retrieve a list of API Requests that have been made.
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
GET	`/vaults/{vaultUuid}`	Get Vault details and metadata
GET	`/vaults/{vaultUuid}/items`	Get all items for inside a Vault
POST	`/vaults/{vaultUuid}/items`	Create a new Item
GET	`/vaults/{vaultUuid}/items/{itemUuid}`	Get the details of an Item
PUT	`/vaults/{vaultUuid}/items/{itemUuid}`	Update an Item
PATCH	`/vaults/{vaultUuid}/items/{itemUuid}`	Update a subset of Item attributes
DELETE	`/vaults/{vaultUuid}/items/{itemUuid}`	Delete 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

Questions

Does the 1Password Connect API need an API key?

Yes. The 1Password Connect API uses Bearer token authentication; the documentation explains how to get credentials.

Does the 1Password Connect API support HTTPS?

Yes, the 1Password Connect API is served over HTTPS.

How many endpoints does the 1Password Connect API have?

Its OpenAPI description lists 15 endpoints in version 1.5.7. All of them are shown on this page.

What are alternatives to the 1Password Connect API?

Other Security APIs include Microsoft Security Response Center (MSRC), National Vulnerability Database, Cisco PSIRT openVuln API, Shodan, BitWarden.

Compare alternatives →

Microsoft Security Response Center (MSRC)

Security

Programmatic interfaces to engage with the Microsoft Security Response Center (MSRC)

No auth

National Vulnerability Database

Security

U.S. National Vulnerability Database

No auth

Cisco PSIRT openVuln API

Security

The Cisco Product Security Incident Response Team (PSIRT) openVuln API is a RESTful API that allows customers to obtain Cisco Security Vulnerability information in different machine-consumable formats. APIs are important for customers because they allow their technical staff and programmers to build tools that help them do their job more effectively (in this case, to keep up with security vulnerability information). For more information about the Cisco PSIRT openVuln API visit https://developer.cisco.com/site/PSIRT/discover/overview For detail steps on how to use the API go to:https://developer.cisco.com/site/PSIRT/get-started/getting-started.gsp This is a beta release of a swagger YAML for the Cisco PSIRT openVuln API To access the API sign in with your Cisco CCO account at http://apiconsole.cisco.com and register an application to recieve a client_id and a client_secret You can then get your token using curl or any other method you prefer. 'curl -s -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "client_id=<your_client_id>" -d "client_secret=<your_client_secret>" -d "grant_type=client_credentials" https://cloudsso.cisco.com/as/token.oauth2' You will receive an access token as demonstrated in the following example: '{"access_token":"I7omWtBDAieSiUX3shOxNJfuy4J6","token_type":"Bearer","expires_in":3599}' In Swagger, click on Change Authentication enter the text "I7omWtBDAieSiUX3shOxNJfuy4J6" (which is the token you received) then click on "Try this operation"

OAuth19 endpoints