Skip to content
localisyncDocs
Open panel

Download a verified locale file

Distribution and channel-scoped bearer key required. Verify Ed25519 signatures, monotonic catalog revision, immutable manifest digest and file hashes. No management dependencies. Files use private immutable caching; channel manifests require revalidation.

GET /delivery/v1/distributions/{id}/channels/{channel}/releases/{releaseId}/files/{hash}

Operation: getDeliveryFile · Download OpenAPI

Requires a distribution and channel-scoped bearer read key. It does not use panel cookies or CSRF. See the delivery protocol.

readKey

{
"type": "http",
"scheme": "bearer",
"description": "A distribution and channel-scoped read key. Never send it in a URL."
}
Name Location Required Description
id path Yes See constraints below.
channel path Yes See constraints below.
releaseId path Yes See constraints below.
hash path Yes See constraints below.
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"enum": [
"preview",
"production"
]
}
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}

No request body.

Verified content.

Response headers:

{
"ETag": {
"schema": {
"type": "string"
}
}
}

Content type: application/json Schema reference: LocaleFile.

Field Type Required Constraints / description
protocol number Yes —
releaseId string Yes format: "uuid"; pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
locale string Yes minLength: 1; maxLength: 255; pattern: "^[A-Za-z0-9-]+$"
entries Array of object Yes maxItems: 10000
{
"$ref": "#/components/schemas/LocaleFile"
}

Invalid path or request.

Invalid key, channel scope or web origin.

Not published or no accessible immutable release.

Request rate limit exceeded.

Unexpected delivery failure; X-Request-ID identifies the safe event.

Local storage or dependency unavailable; X-Request-ID identifies the safe event.

Request errors and safe retries · Troubleshooting

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.