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}
Parameters
Path Parameters
string
/^[\da-z]{26}$/
The UUID of the Vault the item is in
string
/^[\da-z]{26}$/
The UUID of the Item to update
Request Body
Array<object>
object
string
Allowed values: add remove replace
An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute
string
Examples
Update specific Item attributes
Add a new ItemField to the Item
Modify a specific ItemField attribute.
Modify or remove an ItemField.
Replace an entire Item with new fields. Equivalent to a PUT request.
Responses
200
OK - Item updated. If no Patch operations were provided, Item is unmodified.
object
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
state
string
Allowed values: ARCHIVED DELETED
urls
Array<object>
object
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
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
length
Length of the generated value
integer
default: 32 >= 1 <= 64
string
default: STRING
Allowed values: STRING EMAIL CONCEALED URL TOTP DATE MONTH_YEAR MENU
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
section
For files that are in a section, this field describes the section.
object
size
Size in bytes of the file
integer
401
object
message
A message detailing the error
string
Example
403
object
message
A message detailing the error
string
Example
404
object
message
A message detailing the error
string
Examples
Item not found
Vault not found