Skip to main content

Attachments and Fields

Attach a file to an existing vault item

POST /attachment

Attach a file to an existing safe item by specifying a unique object identifier in the path and the file in the request body.

Parameters:

  • Id - Unique identifier of the item to attach a file to.

Request URL examples:

  • https://domain.com

Retrieve an attachment

GET /object/attachment/{id}

Retrieve an attachment by specifying the attachment id in the path and item id as a query parameter.

If you're retrieving any file type other than plaintext, we recommend posting the request through a browser window for immediate download.

Parameters:

  • Id - Unique identifier of the attachment.

  • Itemid - Unique identifier of the item the file is attached to.

Request URL examples :

  • https://domain.com

Delete an attachment

DELETE /object/attachment/{id}

Delete an attachment by specifying the attachment id in the path and item id as a query parameter.

Parameters:

  • Id - Unique identifier of the attachment.

  • Itemid - Unique identifier of the item the file is attached to.

Request URL examples:

  • https://domain.com

Retrieve the username of a login item

GET /object/username/{id}

Retrieve the username of a login item by specifying the item's unique object identifier in the path.

Parameters:

  • Id - Unique identifier of the item.

Request URL examples:

  • https://domain.com

Retrieve the password of a login item

GET /object/password/{id}

Retrieve the password of a login item by specifying the item's unique object identifier in the path.

Parameters:

  • Id - Unique identifier of the item.

Request URL examples:

  • https://domain.com

Retrieve the URI of a login item

GET /object/uri/{id}

Retrieve the URI of a login item by specifying the item's unique object identifier in the path.

Parameters:

  • Id - Unique identifier of the item.

Request URL examples:

  • https://domain.com

Retrieve the TOTP code of a login item

GET /object/totp/{id}

Retrieve the TOTP code of a login item by specifying the item's unique object identifier in the path.

Parameters:

  • Id - Unique identifier of the item.

Request URL examples:

  • https://domain.com

Retrieve the notes of an item

GET /object/notes/{id}

Retrieve the notes of an item by specifying the item's unique object identifier in the path.

Parameters:

  • Id - Unique identifier of the item.

Request URL examples:

  • https://domain.com

Retrieve the number of times a password has been exposed for a login item

GET /object/exposed/{id}

Retrieve the number of times a password has been exposed for a login item by specifying the item's unique object identifier in the path.

Parameters:

  • Id - Unique identifier of the item.

Request URL examples:

  • https://domain.com