Sync a source

Read a source's translation files from a deployment pipeline, without a backoffice login.

POST/umbraco/app-translations/api/v1/sources/{alias}/sync

Syncs one source and waits for it to finish. The endpoint is off until you configure a secret or register the deployment sync policy. Send the secret below, or what your policy checks, such as an OIDC token.

aliaspathstringrequired

The source identifier, from the source’s Advanced settings.

Authorizationheaderstring

The deployment sync key, as a bearer token.

X-Oidc-Tokenheaderstring

An OIDC token, when the deployment sync policy uses API OIDC’s scheme. API OIDC reads this header unless you configured another.

Response

syncIdstringrequired

The sync’s identifier, as History lists it.

sourceIdstringrequired

The source’s identifier.

revisionstringrequired

A fingerprint of the files the sync read.

startedAtstringrequired

When the sync started, as an ISO 8601 timestamp.

completedAtstringrequired

When it finished.

statusstringrequired

How the sync ended.

addedCountintegerrequired

New keys.

changedCountintegerrequired

Keys whose default text changed.

missingCountintegerrequired

Keys the files no longer have, deleted or kept as No longer used.

invalidCountintegerrequired

Not 0 when the files could not be read as messages.

errorstring

What went wrong, when something did.

Status	Meaning
`200`	Synced.
`401`	The key or token is missing or wrong.
`403`	The token is valid, but the policy doesn’t let it in.
`404`	No source has that identifier.
`409`	The source is turned off, or already syncing.
`502`	Umbraco could not fetch or read the translation files.
`503`	No key is configured and no deployment sync policy is registered, so the endpoint is off.

Request

curl -X POST 'https://umbraco.example.com/umbraco/app-translations/api/v1/sources/website/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://umbraco.example.com/umbraco/app-translations/api/v1/sources/website/sync", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.post(
    "https://umbraco.example.com/umbraco/app-translations/api/v1/sources/website/sync",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)