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}

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/vaults//items/' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "op": "replace",
        "path": "/favorite",
        "value": true
    },
    {
        "op": "remove",
        "path": "/tags/1"
    }
]'

Response Example

200 - Example 1

{
    "category": "LOGIN",
    "createdAt": "2019-08-24T14:15:22Z",
    "favorite": false,
    "id": "string",
    "lastEditedBy": "string",
    "state": "ARCHIVED",
    "tags": [
        "string"
    ],
    "title": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "urls": [
        {
            "href": "https://example.com",
            "primary": true
        },
        {
            "href": "https://example.org"
        }
    ],
    "vault": {
        "id": "string"
    },
    "version": 0,
    "fields": [
        {
            "entropy": 0,
            "generate": false,
            "id": "string",
            "label": "string",
            "purpose": "",
            "recipe": {
                "characterSets": [
                    "LETTERS"
                ],
                "length": 32
            },
            "section": {
                "id": "string"
            },
            "type": "STRING",
            "value": "string"
        }
    ],
    "files": [
        {
            "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo=",
            "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
            "id": "6r65pjq33banznomn7q22sj44e",
            "name": "foo.txt",
            "size": 35
        }
    ],
    "sections": [
        {
            "id": "string",
            "label": "string"
        }
    ]
}

Request

Path Params

Body Params application/json

Examples

Responses

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

application/json

Body

🟠401Invalid or missing token

🟠403Unauthorized access

🟠404Item not found

Modified at 2022-09-02 07:10:37

Get the details of an Item

Update an Item