Skip to content
Starlight OpenAPI

Get the details of a File

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

Authorizations

Parameters

Path Parameters

vaultUuid
required
string format: uuid

The UUID of the Vault to fetch Item from

itemUuid
required
string format: uuid

The UUID of the Item to fetch File from

fileUuid
required
string format: uuid

The UUID of the File to fetch

Query Parameters

inline_files
boolean
true

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

Responses

200

OK

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
id

ID of the file

string
name

Name of the file

string
section

For files that are in a section, this field describes the section.

object
id
string
size

Size in bytes of the file

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

401

Invalid or missing token

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "Invalid token signature",
  "status": 401
}

403

Unauthorized access

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "vault {vaultUuid} is not in scope",
  "status": 403
}

404

File not found

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Examples

File not found

{
  "message": "file {fileUuid} not found",
  "status": 404
}

413

File content too large to display

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Examples

File too large

{
  "message": "File is too large to inline in request. Use the /v1/vaults/{vaultUUID}/items/{itemUUID}/files/{fileUUID}/content endpoint instead.",
  "status": 413
}