Skip to Content
Authgate 1.7.0 is released 🎉
API ReferenceDownload File

Download File

Download a file from your Authgate application.

Endpoint: GET /files/{file_id}/download

Path Parameters:

  • file_id (required) - The UUID of the file to download

Headers:

  • x-api-key (required) - Your application’s API key
  • x-api-secret (required) - Your application’s API secret

User Authentication (optional or required):

If your app allows anonymous access, user authentication is optional. Otherwise, include one of:

  • Authorization: Bearer <session_token>
  • x-api-license-code: <license_code> + x-hardware-id (if device auth enabled)
  • x-api-username + x-api-password + x-hardware-id (if device auth enabled)

Response:

The file content is streamed directly as application/octet-stream.

Example Request:

curl -X GET "https://your-domain.com/api/integration/files/789e0123-e89b-12d3-a456-426614174000/download" \ -H "x-api-key: your_api_key" \ -H "x-api-secret: your_api_secret" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \ -o downloaded_file.bin

Errors:

  • 401 - Authentication failed
  • 403 - Inactive/expired membership
  • 404 - File not found

Notes:

  • Get available file IDs from the /app_context endpoint
  • Files can be encrypted - check the is_encrypted flag in app context
Last updated on