1Password Connect
  1. Health
1Password Connect
  • Activity
    • Retrieve a list of API Requests that have been made.
      GET
  • Health
    • Get state of the server and its dependencies.
      GET
    • Ping the server for liveness
      GET
  • Metrics
    • Query server for exposed Prometheus metrics
      GET
  • Vaults
    • Get all Vaults
      GET
    • Get Vault details and metadata
      GET
  • Items
    • Get all items for inside a Vault
      GET
    • Create a new Item
      POST
    • Delete an Item
      DELETE
    • Get the details of an Item
      GET
    • Update a subset of Item attributes
      PATCH
    • Update an Item
      PUT
  • Files
    • Get all the files inside an Item
      GET
    • Get the details of a File
      GET
    • Get the content of a File
      GET
  1. Health

Get state of the server and its dependencies.

GET
/health
Health
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/health'
Response Response Example
{
  "dependencies": [
    {
      "service": "sync",
      "status": "TOKEN_NEEDED"
    },
    {
      "message": "Connected to./1password.sqlite",
      "service": "sqlite",
      "status": "ACTIVE"
    }
  ],
  "name": "1Password Connect API",
  "version": "1.2.1"
}

Request

None

Responses

🟢200OK
application/json
Body
dependencies
array[object (ServiceDependency) {3}] 
optional
message
string 
optional
Human-readable message for explaining the current state.
service
string 
optional
status
string 
optional
name
string 
required
version
string 
required
The Connect server's version
Modified at 2022-09-02 07:10:37
Previous
Retrieve a list of API Requests that have been made.
Next
Ping the server for liveness
Built with