API referenceFiles

Read file or folder metadata

Read metadata of a file or folder at the target path. This API operation reports whether the object at the target path is a file or folder. If a file, it also reports the file size and last modification time. <Note>Ensure the path is accessible within the context defined by the `IB-Context` header.</Note>

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Path Parameters

pathstringRequired
Full path to the file or folder.

Headers

IB-ContextstringOptional
Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.
IB-Retry-ConfigstringOptional

Configures retry logic if no file or folder is found at the target path. Uses a constant backoff algorithm. Don’t retry if this header isn’t provided. Example: {'retries': 3, 'backoff-seconds': 5}

Response

Successfully retrieved metadata.

Errors