Skip to content
Starlight OpenAPI

Get Vault details and metadata

GET
/vaults/{vaultUuid}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
vaultUuid
required
string
/^[\da-z]{26}$/

The UUID of the Vault to fetch Items from

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
attributeVersion

The vault version

integer
contentVersion

The version of the vault contents

integer
createdAt
string format: date-time
description
string
id
string
/^[\da-z]{26}$/
items

Number of active items in the vault

integer
name
string
type
string
Allowed values: USER_CREATED PERSONAL EVERYONE TRANSFER
updatedAt
string format: date-time

401

Section titled “401 ”

Invalid or missing token

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "Invalid token signature",
  "status": 401
}

403

Section titled “403 ”

Unauthorized access

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "vault {vaultUuid} is not in scope",
  "status": 403
}

404

Section titled “404 ”

Vault not found

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "vault {itemUuid} not found",
  "status": 404
}