API V2 (Beta) · Project Settings
Update project settings
curl --request PATCH \ --url https://api.lingohub.com/v2/projects/PROJECT_ID/settings \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{}'import requests
url = "https://api.lingohub.com/v2/projects/PROJECT_ID/settings"
payload = {}headers = { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v2/projects/PROJECT_ID/settings';const options = { method: 'PATCH', headers: {Authorization: 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json'}, body: '{}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.lingohub.com/v2/projects/PROJECT_ID/settings"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY") req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");RequestBody body = RequestBody.create(mediaType, "{}");Request request = new Request.Builder() .url("https://api.lingohub.com/v2/projects/PROJECT_ID/settings") .patch(body) .addHeader("Authorization", "Bearer YOUR_API_KEY") .addHeader("Content-Type", "application/json") .build();
Response response = client.newCall(request).execute();<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://api.lingohub.com/v2/projects/PROJECT_ID/settings', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', 'Content-Type' => 'application/json', ],]);
echo $response->getBody();require 'uri'require 'net/http'
url = URI("https://api.lingohub.com/v2/projects/PROJECT_ID/settings")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Patch.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'request["Content-Type"] = 'application/json'request.body = "{}"
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://api.lingohub.com/v2/projects/PROJECT_ID/settings"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, }, Content = new StringContent("{}") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}Changes any of the project’s settings (JSON merge-patch): send only the sections and fields that change; lists are replaced as a whole. Imports and exports that start, or are queued without their own settings, use the new values; existing keys and texts aren’t rewritten. Integration settings apply from the next sync. All changes are applied together or not at all. Requires project-level settings management permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde
Header Parameters
Section titled “Header Parameters”Optional. The quoted ETag from a GET of this resource. The change is applied only if the resource still has that version; otherwise the request fails with 412 precondition_failed. See Conditional updates.
Request Bodyrequired
Section titled “Request Bodyrequired”Request body to change a project’s settings (JSON merge-patch): send only the sections and fields that change, also inside the sections of format. Lists are replaced as a whole; null removes a format section.
object
Export defaults.
object
The statuses a source text needs to be exported.
Example
[ "APPROVED"]The statuses a target text needs to be exported.
Example
[ "APPROVED"]What an export does with an empty source text.
Example
KEEPWhat an export does with an empty target text.
Example
SKIPWhether exports exclude not-translatable entries.
Example
falseHow exports write HTML in the formats that support it.
Example
CDATAImport defaults.
object
Whether imports may create source text entries.
Example
trueWhen imports may update an existing source text.
Example
ALWAYSWhether imports may update source metadata.
Example
trueWhether imports may deactivate source entries missing from the input.
Example
falseWhether imports may create target text entries.
Example
trueWhen imports may update an existing target text.
Example
ONLY_EMPTYWhether imports may update target metadata.
Example
trueWhether imports may deactivate target entries missing from the input.
Example
falseFile-format options. Null removes them, which only documents and integration projects allow.
The options of the project’s file format, in sections. Which sections a project needs depends on its type: general for every file-based type except DOCUMENT; csv for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; escape for STANDARD_PROPERTIES and STANDARD_INI; json for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; i18next_json for I18NEXT_JSON; xliff for STANDARD_XLIFF; properties for STANDARD_PROPERTIES. A section the type doesn’t need has no effect.
object
Options every file format uses; changed field by field.
object
The character encoding of exported files.
Example
UTF_8Which exported files carry their language code in the file name or path.
Example
ALLUse source content when supported.
Example
trueSpaces per indentation level, 0 to 100; null uses 2.
Example
2End output in a newline.
Example
trueCSV options; changed field by field, null removes them.
Changes how CSV files are read and written, field by field.
object
Let imports update detected CSV settings.
Example
trueThe header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.
Example
keyThe header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.
Example
descriptionThe character between the columns.
Example
;The character that encloses a value.
Example
"Include status information in CSV output.
Example
falseXLIFF options; changed field by field, null removes them.
Changes how XLIFF files identify keys and languages, field by field.
object
Use resname for segment identity.
Example
falseFile contains multiple languages.
Example
falseKey normalisation.
object
How keys are normalised when they are imported, created or renamed. Existing keys aren’t renamed.
Example
FORMAT_SPECIFICPlaceholder recognition.
object
The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Send default_definitions to go back to the defaults.
Example
[ "DEFAULT_ICU", "DEFAULT_PRINTF"]Integration settings; only for a project that has an integration.
object
Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.
Example
trueWhether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.
Example
falseRequest body to change a project’s settings (JSON merge-patch): send only the sections and fields that change, also inside the sections of format. Lists are replaced as a whole; null removes a format section.
object
Export defaults.
object
The statuses a source text needs to be exported.
Example
[ "APPROVED"]The statuses a target text needs to be exported.
Example
[ "APPROVED"]What an export does with an empty source text.
Example
KEEPWhat an export does with an empty target text.
Example
SKIPWhether exports exclude not-translatable entries.
Example
falseHow exports write HTML in the formats that support it.
Example
CDATAImport defaults.
object
Whether imports may create source text entries.
Example
trueWhen imports may update an existing source text.
Example
ALWAYSWhether imports may update source metadata.
Example
trueWhether imports may deactivate source entries missing from the input.
Example
falseWhether imports may create target text entries.
Example
trueWhen imports may update an existing target text.
Example
ONLY_EMPTYWhether imports may update target metadata.
Example
trueWhether imports may deactivate target entries missing from the input.
Example
falseFile-format options. Null removes them, which only documents and integration projects allow.
The options of the project’s file format, in sections. Which sections a project needs depends on its type: general for every file-based type except DOCUMENT; csv for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; escape for STANDARD_PROPERTIES and STANDARD_INI; json for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; i18next_json for I18NEXT_JSON; xliff for STANDARD_XLIFF; properties for STANDARD_PROPERTIES. A section the type doesn’t need has no effect.
object
Options every file format uses; changed field by field.
object
The character encoding of exported files.
Example
UTF_8Which exported files carry their language code in the file name or path.
Example
ALLUse source content when supported.
Example
trueSpaces per indentation level, 0 to 100; null uses 2.
Example
2End output in a newline.
Example
trueCSV options; changed field by field, null removes them.
Changes how CSV files are read and written, field by field.
object
Let imports update detected CSV settings.
Example
trueThe header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.
Example
keyThe header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.
Example
descriptionThe character between the columns.
Example
;The character that encloses a value.
Example
"Include status information in CSV output.
Example
falseXLIFF options; changed field by field, null removes them.
Changes how XLIFF files identify keys and languages, field by field.
object
Use resname for segment identity.
Example
falseFile contains multiple languages.
Example
falseKey normalisation.
object
How keys are normalised when they are imported, created or renamed. Existing keys aren’t renamed.
Example
FORMAT_SPECIFICPlaceholder recognition.
object
The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Send default_definitions to go back to the defaults.
Example
[ "DEFAULT_ICU", "DEFAULT_PRINTF"]Integration settings; only for a project that has an integration.
object
Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.
Example
trueWhether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.
Example
falseResponses
Section titled “Responses”The project’s settings after the change.
All settings of a project: export and import defaults, file-format options, key normalisation, placeholder recognition and, if the project has an integration, the integration settings.
object
Always PROJECT_SETTINGS.
The project these settings belong to.
Export defaults.
object
The statuses a source text needs to be exported. Null on older projects that never stored a selection.
The statuses a target text needs to be exported. Null on older projects that never stored a selection.
What an export does with an empty source text.
What an export does with an empty target text.
Whether exports exclude not-translatable entries.
How exports write HTML in the formats that support it.
Import defaults.
object
Whether imports may create source text entries.
When imports may update an existing source text.
Whether imports may update source metadata.
Whether imports may deactivate source entries missing from the input.
Whether imports may create target text entries.
When imports may update an existing target text.
Whether imports may update target metadata.
Whether imports may deactivate target entries missing from the input.
File-format options; null for documents and integration projects, which have none.
The options of the project’s file format, in sections. Which sections a project needs depends on its type: general for every file-based type except DOCUMENT; csv for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; escape for STANDARD_PROPERTIES and STANDARD_INI; json for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; i18next_json for I18NEXT_JSON; xliff for STANDARD_XLIFF; properties for STANDARD_PROPERTIES. A section the type doesn’t need has no effect.
object
Options every file format uses.
Options every file format uses.
object
Whether to use source content when missing in supported file processing.
Spaces per indentation level, in the formats that indent.
Whether output ends in a newline.
CSV options; required for the CSV project types.
How CSV files are read and written.
object
Whether imports may update CSV settings from detected file content.
The header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.
The header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.
The character between the columns. Null on older projects that never stored one.
The character that encloses a value. Null on older projects that never stored one.
Whether CSV exports include status information.
I18next options; required for I18NEXT_JSON.
How i18next JSON files are read and written.
object
Whether exports include base plural keys.
Key normalisation.
object
How keys are normalised when they are imported, created or renamed. Null on older projects that never stored one.
How keys are normalised when they are imported, created or renamed: FORMAT_SPECIFIC as the file format requires, ALL always, NONE never. Existing keys aren’t renamed.
Placeholder recognition.
object
The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Null on older projects that never stored a list.
The placeholder kinds of the project’s type; read-only. Send them as definitions to go back to the defaults.
definitions equals default_definitions; read-only.
Integration settings; null when the project has no integration.
What a sync of the project’s integration deletes; every integration type has them.
object
Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.
Whether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.
Example
{ "object_type": "PROJECT_SETTINGS", "id": "pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "export": { "source_statuses": [ "APPROVED" ], "target_statuses": [ "APPROVED" ], "source_empty_content_handling": "KEEP", "target_empty_content_handling": "KEEP", "is_not_translatable_skipped": false, "html_encoding": "RAW" }, "import": { "is_source_creation_enabled": true, "source_text_update_mode": "ALWAYS", "is_source_metadata_update_enabled": true, "is_source_deactivation_enabled": false, "is_target_creation_enabled": true, "target_text_update_mode": "ALWAYS", "is_target_metadata_update_enabled": true, "is_target_deactivation_enabled": false }, "format": { "general": { "charset": "UTF_8", "file_name_languages": "ALL", "is_source_used_when_missing": true, "comment_languages": "SOURCE", "indentation": 2, "is_final_newline_enabled": true }, "csv": { "is_import_detection_enabled": true, "key_header": "key", "description_header": "description", "delimiter": ";", "quote": "\"", "is_status_exported": false }, "escape": { "is_character_escaping_enabled": true }, "json": { "is_array_indentation_enabled": false, "is_plural_order_alphabetical": false }, "i18next_json": { "version": "VERSION_4", "is_base_plural_exported": false }, "xliff": { "is_resname_identifier": false, "is_multi_language": false }, "properties": { "plural_separator": "_" } }, "keys": { "normalization_strategy": "FORMAT_SPECIFIC" }, "placeholders": { "definitions": [ "DEFAULT_ICU", "DEFAULT_PRINTF" ], "default_definitions": [ "DEFAULT_ICU", "DEFAULT_PRINTF" ], "is_default": true }, "integrations": { "is_removed_resource_deletion_enabled": true, "is_removed_language_deletion_enabled": false }}Headers
Section titled “Headers”Opaque strong validator for this representation. Keep its quotation marks and use it as If-Match on a documented conditional write. A replay carries the original ETag, which may now be stale.
State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
Invalid or missing API key.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Insufficient permissions.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The resource does not exist, or the API key cannot see it.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The current representation does not match If-Match (precondition_failed). No change was applied.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The request is well-formed, but values are invalid; errors points at each of them.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”Seconds to wait before retrying.
State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
An unexpected internal server error occurred.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.
RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.
object
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.
object
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
Example
{ "type": "https://api.lingohub.com/errors/resource-not-found", "title": "Resource not found", "status": 404, "detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.", "instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde", "code": "invalid_json", "request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "errors": [ { "detail": "must be at least 2 characters long", "pointer": "#/name", "parameter": "limit", "code": "minLength" } ], "required_permission": { "scope": "WORKSPACE", "target": "GENERAL", "level": "NO_ACCESS" }}Headers
Section titled “Headers”Seconds to wait before retrying.
State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.
The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.