Sign in

v1

latestOpenAPI 3.0.22026-07-13151037.3 KB
Files

Get the details of a File

get/vaults/{vaultUuid}/items/{itemUuid}/files/{fileUuid}

Path parameters

vaultUuidstring uuid required

The UUID of the Vault to fetch Item from

itemUuidstring uuid required

The UUID of the Item to fetch File from

fileUuidstring uuid required

The UUID of the File to fetch

Query parameters

inline_filesboolean
Example:true

Tells server to return the base64-encoded file contents in the response.

Response

OK

idstring

ID of the file

namestring

Name of the file

sizeinteger

Size in bytes of the file

content_pathstring

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

contentstring byte

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

Example response

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