Skip to main content
PATCH
/
vaults
/
{vaultUuid}
/
items
/
{itemUuid}
curl --request PATCH \
  --url http://localhost:8080/v1/vaults/{vaultUuid}/items/{itemUuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "op": "replace",
    "path": "/",
    "value": {
      "title": "New Title",
      "favorite": true,
      "tags": [
        "tag1",
        "tag2"
      ],
      "...": "Any attr from FullItem schema"
    }
  }
]
'
{
  "vault": {
    "id": "<string>"
  },
  "category": "LOGIN",
  "id": "<string>",
  "title": "<string>",
  "urls": [
    {
      "primary": true,
      "href": "https://example.com"
    },
    {
      "href": "https://example.org"
    }
  ],
  "favorite": false,
  "tags": [
    "<string>"
  ],
  "version": 123,
  "state": "ARCHIVED",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "lastEditedBy": "<string>",
  "sections": [
    {
      "id": "<string>",
      "label": "<string>"
    }
  ],
  "fields": [
    {
      "id": "<string>",
      "type": "STRING",
      "section": {
        "id": "<string>"
      },
      "purpose": "",
      "label": "<string>",
      "value": "<string>",
      "generate": false,
      "recipe": {
        "length": 32,
        "characterSets": [
          "LETTERS"
        ],
        "excludeCharacters": "abc1"
      },
      "entropy": 123
    }
  ],
  "files": [
    {
      "id": "6r65pjq33banznomn7q22sj44e",
      "name": "foo.txt",
      "size": 35,
      "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
      "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
vaultUuid
string
required

The UUID of the Vault the item is in

​
itemUuid
string
required

The UUID of the Item to update

Body

application/json
​
op
enum<string>
required
Available options:
add,
remove,
replace
​
path
string
required

An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute

Example:

"/fields/06gnn2b95example10q91512p5/label"

​
value
object

Response

OK - Item updated. If no Patch operations were provided, Item is unmodified.

​
vault
object
required
​
category
enum<string>
required
Available options:
LOGIN,
PASSWORD,
API_CREDENTIAL,
SERVER,
DATABASE,
CREDIT_CARD,
MEMBERSHIP,
PASSPORT,
SOFTWARE_LICENSE,
OUTDOOR_LICENSE,
SECURE_NOTE,
WIRELESS_ROUTER,
BANK_ACCOUNT,
DRIVER_LICENSE,
IDENTITY,
REWARD_PROGRAM,
DOCUMENT,
EMAIL_ACCOUNT,
SOCIAL_SECURITY_NUMBER,
MEDICAL_RECORD,
SSH_KEY,
CUSTOM
​
id
string
​
title
string
​
urls
object[]
Example:
[
  {
    "primary": true,
    "href": "https://example.com"
  },
  { "href": "https://example.org" }
]
​
favorite
boolean
default:false
​
tags
string[]
​
version
integer
​
state
enum<string>
Available options:
ARCHIVED,
DELETED
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
lastEditedBy
string
​
sections
object[]
​
fields
object[]
​
files
object[]