Sign in

v1

latestOpenAPI 3.0.22026-07-13151037.3 KB
Items

Update a subset of Item attributes

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}

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

Path parameters

vaultUuidstring required

The UUID of the Vault the item is in

itemUuidstring required

The UUID of the Item to update

Request body

op'add' | 'remove' | 'replace' required
pathstring required

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

valueobject

Example request

[
  {
    "path": "/fields/06gnn2b95example10q91512p5/label"
  }
]

Response

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

idstring
titlestring
category'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' required
favoriteboolean
tagsstring[]
versioninteger
state'ARCHIVED' | 'DELETED'
createdAtstring date-time
updatedAtstring date-time
lastEditedBystring

Example response

{
  "urls": [
    {
      "primary": true,
      "href": "https://example.com"
    },
    {
      "href": "https://example.org"
    }
  ],
  "fields": [
    {
      "recipe": {
        "excludeCharacters": "abc1"
      }
    }
  ],
  "files": [
    {
      "id": "6r65pjq33banznomn7q22sj44e",
      "name": "foo.txt",
      "size": 35,
      "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
      "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
    }
  ]
}