1Password Connect
REST API interface for 1Password Connect.
Identity & security#openapi#security
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
REST API interface for 1Password Connect.
Endpoints 15
Items
- GETGet all items for inside a Vault
/vaults/:vaultUuid/items?filter=title eq "Some Item Name" - POSTCreate a new Item
/vaults/:vaultUuid/items - GETGet the details of an Item
/vaults/:vaultUuid/items/:itemUuid - PUTUpdate an Item
/vaults/:vaultUuid/items/:itemUuid - DELETEDelete an Item
/vaults/:vaultUuid/items/:itemUuid - PATCHUpdate a subset of Item attributes
/vaults/:vaultUuid/items/:itemUuidApplies a modified RFC6902 JSON Patch document to an Item or ItemField. This endpoint only supports add, remove and replace operations. When modifying a…
Vaults
- GETGet all Vaults
/vaults?filter=name eq "Some Vault Name" - GETGet Vault details and metadata
/vaults/:vaultUuid
Activity
- GETRetrieve a list of API Requests that have been made.
/activity?limit=10&offset=50
Health
- GETGet state of the server and its dependencies.
http://localhost:8080/health - GETPing the server for liveness
http://localhost:8080/heartbeat
Metrics
- GETQuery server for exposed Prometheus metrics
http://localhost:8080/metricsSee Prometheus documentation for a complete data model.
Files
- GETGet all the files inside an Item
/vaults/:vaultUuid/items/:itemUuid/files?inline_files=true - GETGet the details of a File
/vaults/:vaultUuid/items/:itemUuid/files/:fileUuid?inline_files=true - GETGet the content of a File
/vaults/:vaultUuid/items/:itemUuid/files/:fileUuid/content
API details
- Base URL
http://1password.localhttp://localhost:8080/v1- Authentication
- A bearer token in the Authorization header
- Operations
- 15 operations on 11 pathsGET 11PUT 1POST 1PATCH 1DELETE 1
- Main resources
- Items 6Files 3Health 2Vaults 2Activity 1Metrics 1
- Response formats
application/jsontext/plainapplication/octet-stream- Description format
- OpenAPI 3.0.2, API version
1.5.7 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the 1Password Connect in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the 1Password Connect collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get all items for inside a Vault” (GET /vaults/:vaultUuid/items?filter=title eq "Some Item Name"), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 1Password Connect?
REST API interface for 1Password Connect. It is listed under Identity & security and has 15 endpoints.
Who publishes the 1Password Connect?
It is listed from 1Password's public API description (an OpenAPI document), not published by 1Password on Swastik Codes. Anyone who controls 1password.com can claim the profile by adding a DNS TXT record.
What is the base URL of the 1Password Connect?
Its description lists 2 base URLs: http://1password.local, http://localhost:8080/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the 1Password Connect?
With A bearer token in the Authorization header.
How many endpoints does the 1Password Connect have?
15 operations on 11 paths (11 GET, 1 PUT, 1 POST, 1 PATCH, 1 DELETE). The largest groups are Items, Files, Health, Vaults.
Is forking the 1Password Connect free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.