Forward API reference.
Description
Retrieves metadata for a single File by its ID.
Path
GET /api/v1/forward/files/{file_id}
Request headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id | string | Yes | File ID to retrieve. |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | No | For Identity-owned resources only. PATs may supply this query parameter; omitting it uses the administrator scope. SAT ownership is determined by the credential; any SAT (including Admin SAT) explicitly supplying this parameter, even with an empty value, receives HTTP 400. See Identity ownership. |
Example request
Example response
HTTP 200 OK
Response fields
The response is a File object.
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | The request body, path parameters, or query parameters are invalid, including any SAT explicitly supplying query identity_id (even with an empty value). |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | An owner mismatch occurs in the administrator scope, or a downstream service denies access. |
| 404 | not_found_error | The File does not exist or is not visible in the current Identity scope; the Identity specified by the PAT is invalid, disabled, deleted, or outside the caller's ownership. |
| 500/502/503 | api_error | Forward or a dependent service failed. |