Update a subset of Item attributes

PATCH

/vaults/{vaultUuid}/items/{itemUuid}

Applies a modified RFC6902 JSON Patch document to an Item or ItemField. This endpoint only supports add, remove and replace operations.

When modifying a specific ItemField, the ItemField’s ID in the path attribute of the operation object: /fields/{fieldId}

Authorizations

• ConnectToken

Parameters

Path Parameters

vaultUuid

required

string

/^[\da-z]{26}$/

The UUID of the Vault the item is in

itemUuid

required

string

/^[\da-z]{26}$/

The UUID of the Item to update

Request Body

Array<object>

object

op

required

string

Allowed values: add remove replace

path

required

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

string

/fields/06gnn2b95example10q91512p5/label

value

object

Examples

Update specific Item attributes

[
  {
    "op": "replace",
    "path": "/favorite",
    "value": true
  },
  {
    "op": "remove",
    "path": "/tags/1"
  }
]

Add a new ItemField to the Item

[
  {
    "op": "add",
    "path": "/fields",
    "value": {
      "label": "New Field",
      "type": "string",
      "value": "hunter2"
    }
  }
]

Modify a specific ItemField attribute.

[
  {
    "op": "add",
    "path": "/fields/s2ju540zlna8bdj4uro7sj64rk/label",
    "value": "New field name"
  },
  {
    "op": "remove",
    "path": "/fields/s2ju540zlna8bdj4uro7sj64rk/value"
  }
]

Modify or remove an ItemField.

[
  {
    "op": "replace",
    "path": "/fields/r9qxq7xnhfhukoxsc8ymqr0y11",
    "value": {
      "label": "Replacement Title",
      "type": "string",
      "value": "new value"
    }
  },
  {
    "op": "remove",
    "path": "/fields/h2nl155dshi043yse7wa3u1hs7"
  }
]

Replace an entire Item with new fields. Equivalent to a PUT request.

[
  {
    "op": "replace",
    "path": "/",
    "value": {
      "...": "Any attr from FullItem schema",
      "favorite": true,
      "tags": [
        "tag1",
        "tag2"
      ],
      "title": "New Title"
    }
  }
]

Responses

200

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

object

category

required

string

Allowed values: 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

createdAt

string format: date-time

favorite

boolean

id

string

/^[\da-z]{26}$/

lastEditedBy

string

state

string

Allowed values: ARCHIVED DELETED

tags

Array<string>

title

string

updatedAt

string format: date-time

urls

Array<object>

object

href

required

string format: url

label

string

primary

boolean

[
  {
    "href": "https://example.com",
    "primary": true
  },
  {
    "href": "https://example.org"
  }
]

vault

required

object

id

required

string

/^[\da-z]{26}$/

version

integer

fields

Array<object>

object

entropy

For fields with a purpose of PASSWORD this is the entropy of the value

number

generate

If value is not present then a new value should be generated for this field

boolean

id

required

string

label

string

purpose

Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.

string

Allowed values: "" USERNAME PASSWORD NOTES

recipe

The recipe is used in conjunction with the “generate” property to set the character set used to generate a new secure value

object

characterSets

Array<string>

<= 3 unique items

Allowed values: LETTERS DIGITS SYMBOLS

excludeCharacters

List of all characters that should be excluded from generated passwords.

string

abc1

length

Length of the generated value

integer

default: 32 >= 1 <= 64

section

object

id

string

type

required

string

default: STRING

Allowed values: STRING EMAIL CONCEALED URL TOTP DATE MONTH_YEAR MENU

value

string

files

Array<object>

object

content

Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and inline_files is set to true.

string format: byte

content_path

Path of the Connect API that can be used to download the contents of this file.

string

id

ID of the file

string

name

Name of the file

string

section

For files that are in a section, this field describes the section.

object

id

string

size

Size in bytes of the file

integer

{
  "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo=",
  "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
  "id": "6r65pjq33banznomn7q22sj44e",
  "name": "foo.txt",
  "size": 35
}

sections

Array<object>

object

id

string

label

string

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

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

Item not found

object

message

A message detailing the error

string

status

HTTP Status Code

integer

Examples

Item not found

{
  "message": "item {itemUuid} not found",
  "status": 404
}

Vault not found

{
  "message": "vault {vaultUuid} not found",
  "status": 404
}