Get Metadata

Get File Metadata

get

Retrieves all metadata of a specific file. This endpoint is subject to audit.

Authorizations

bearerAuth

AuthorizationstringRequired

The File Management API uses JWT (JSON Web Tokens) for authentication.

Obtaining a Token

To retrieve a valid token, you must call the login/idm/tokens endpoint.

• Requirements: Use a Service Account that has been assigned the Content Export Reader role.
• Response: The JWT will be returned in the access_token field of the JSON response.
• Reference: For detailed steps on the handshake, see the OAuth2 Authenticate documentation.

Using the Token

Once obtained, include the token in the Authorization header for all API requests: Authorization: Bearer <access_token>

Path parameters

fileIdstringRequired

The unique ID of the file.

Example: internal_file_id_1

Query parameters

typestring · enumRequired

The type of file being managed.

Possible values:

Responses

200

File metadata retrieved successfully.

application/json

idstringRequired

Unique file identifier.

Example: internal_file_id_1

namestringRequired

File name.

Example: s_POD_ID_SD-2025-01-01-00_ED-2025-05-12-09_GD-2025-05-12_1747050746368.zip.pgp

sizeinteger · int64Optional

File size in bytes.

Example: 1234567

uploadTimestring · date-timeOptional

Timestamp of when the file was uploaded (ISO 8601 format).

Example: 2024-05-15T10:00:00Z

contentTypestringOptional

MIME type of the file.

Example: application/pgp-encrypted

integrityHashstringOptional

A cryptographic hash of the file content.

Example: e79e8e823f2df5091d1e4e1583816c07977d3f11b676f91c9f8dcc53c26e271d

typestringRequired

The type of file.

Example: ContentExport

401

Unauthorized - Authentication failed.

application/json

403

Forbidden - Invalid entitlements.

application/json

404

Not Found - File not found.

application/json

500

Internal Server Error.

application/json

get

/files/v1/{fileId}/metadata

HTTPcURLJavaScriptPython

GET /files/v1/{fileId}/metadata?type=ContentExport HTTP/1.1
Host: yourpodURL.symphony.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "internal_file_id_1",
  "name": "s_POD_ID_SD-2025-01-01-00_ED-2025-05-12-09_GD-2025-05-12_1747050746368.zip.pgp",
  "size": 1234567,
  "uploadTime": "2024-05-15T10:00:00Z",
  "contentType": "application/pgp-encrypted",
  "integrityHash": "e79e8e823f2df5091d1e4e1583816c07977d3f11b676f91c9f8dcc53c26e271d",
  "type": "ContentExport",
  "encryption": {
    "encryptionKeyId": "key_123",
    "alg": "AES256-GCM"
  },
  "typeSpecificMetadata": {
    "jobType": "ADHOC",
    "fileFormat": "Symphony",
    "startTime": "2025-01-01-00T10:00:00Z",
    "endTime": "2025-05-12-09T11:00:00Z",
    "generationDate": "2025-05-12"
  }
}