Get project locales
- Sandbox: available
- Staging: available
- Production: unknown
Returns the languages enabled for your project and its default language.
Auth: bearer token. You need List:read and List:search access, or be a project admin.
Scope: the caller's project (from the token).
Behaviour
- The locale settings are stored as a FHIR
Listin your project. - If the project has no locale settings yet, the route returns 404. Create them with
PATCH /locales. - Localization and content routes accept only the languages returned here.
Example
curl -X GET 'https://api.sandbox.ovok.com/locales' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>The enabled languages and the default language.
application/json- response
id?stringId of the FHIR List that stores the locale settings.
languages*array<>Languages enabled for the project.
1 <= itemsdefaultLanguage*stringDefault language of the project. Always one of languages.
"Cy-az-AZ""Cy-sr-SP""Cy-uz-UZ""Lt-az-AZ""Lt-sr-SP""Lt-uz-UZ""aa""ab""ae""af""af-ZA""ak""am""an""ar""ar-AE""ar-BH""ar-DZ""ar-EG""ar-IQ""ar-JO""ar-KW""ar-LB""ar-LY""ar-MA""ar-OM""ar-QA""ar-SA""ar-SY""ar-TN""ar-YE""as""av""ay""az""ba""be""be-BY""bg""bg-BG""bh""bi""bm""bn""bo""br""bs""ca""ca-ES""ce""ch""co""cr""cs""cs-CZ""cu""cv""cy""da""da-DK""de""de-AT""de-CH""de-DE""de-LI""de-LU""div-MV""dv""dz""ee""el""el-GR""en""en-AU""en-BZ""en-CA""en-CB""en-GB""en-IE""en-JM""en-NZ""en-PH""en-TT""en-US""en-ZA""en-ZW""eo""es""es-AR""es-BO""es-CL""es-CO""es-CR""es-DO""es-EC""es-ES""es-GT""es-HN""es-MX""es-NI""es-PA""es-PE""es-PR""es-PY""es-SV""es-UY""es-VE""et""et-EE""eu""eu-ES""fa""fa-IR""ff""fi""fi-FI""fj""fo""fo-FO""fr""fr-BE""fr-CA""fr-CH""fr-FR""fr-LU""fr-MC""fy""ga""gd""gl""gl-ES""gn""gu""gu-IN""gv""ha""he""he-IL""hi""hi-IN""ho""hr""hr-HR""ht""hu""hu-HU""hy""hy-AM""hz""ia""id""id-ID""ie""ig""ii""ik""io""is""is-IS""it""it-CH""it-IT""iu""ja""ja-JP""jv""ka""ka-GE""kg""ki""kj""kk""kk-KZ""kl""km""kn""kn-IN""ko""ko-KR""kr""ks""ku""kv""kw""ky""ky-KZ""la""lb""lg""li""ln""lo""lt""lt-LT""lu""lv""lv-LV""mg""mh""mi""mk""mk-MK""ml""mn""mn-MN""mr""mr-IN""ms""ms-BN""ms-MY""mt""my""na""nb""nb-NO""nd""ne""ng""nl""nl-BE""nl-NL""nn""nn-NO""no""nr""nv""ny""oc""oj""om""or""os""pa""pa-IN""pi""pl""pl-PL""ps""pt""pt-BR""pt-PT""qu""rm""rn""ro""ro-RO""ru""ru-RU""rw""sa""sa-IN""sc""sd""se""sg""si""sk""sk-SK""sl""sl-SI""sm""sn""so""sq""sq-AL""sr""ss""st""su""sv""sv-FI""sv-SE""sw""sw-KE""ta""ta-IN""te""te-IN""tg""th""th-TH""ti""tk""tl""tn""to""tr""tr-TR""ts""tt""tt-RU""tw""ty""ug""uk""uk-UA""ur""ur-PK""uz""ve""vi""vi-VN""vo""wa""wo""xh""yi""yo""za""zh""zh-CHS""zh-CHT""zh-CN""zh-HK""zh-MO""zh-SG""zh-TW""zu"curl -X GET 'https://api.sandbox.ovok.com/locales'{ "id": "string", "languages": [ "Cy-az-AZ" ], "defaultLanguage": "Cy-az-AZ"}Get Pulsene MQTT settings POST
Returns the MQTT connection settings for a Pulsene MC01 device. The device calls this route on startup to learn which broker to connect to. **Auth:** None at the HTTP level (no bearer token). The body must carry an `apiKey` that matches the key the device firmware ships with. A wrong or missing key is rejected with 401. ## Behaviour - The body must contain `serialNumber` (non-empty string) and `apiKey` (non-empty string). - Ovok does not look the device up. Any serial that passes the key check receives the same response shape: `mqtt.clientId` is the serial you sent, `username` and `password` are the fixed MC01 broker credentials, and `url` is the broker URL configured for the environment. - `wifi` and `pairing` are not returned for this device family. - The route answers `200`. It does not write anything. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/iot-device/pulsene/setup' \ -H 'Content-Type: application/json' \ -d '{ "serialNumber": "<serial>", "apiKey": "<device-api-key>" }' ```
Set project locales PATCH
Sets the languages enabled for your project and its default language. Creates the locale settings if the project has none. **Auth:** bearer token. You need `List:create`, `List:read`, `List:update`, `List:delete` and `List:search` access, or be a project admin. **Scope:** the caller's project (from the token). ## Behaviour - The body replaces the whole setting. `languages` needs at least one language, and `defaultLanguage` must be one of them. - For each language that is new compared with the previous setting, background jobs create AI translations of all localization keys and content items from the previous default language. Existing translations are not changed. - Removing a language does not delete its localizations or content. - Changing `defaultLanguage` does not move or translate anything by itself. ## Example ```bash curl -X PATCH 'https://api.sandbox.ovok.com/locales' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "languages": ["en-US", "de-DE", "fr-FR"], "defaultLanguage": "en-US" }' ```