API V2 (Beta) · Stacks
Replace stack automation settings
curl --request PUT \ --url https://api.lingohub.com/v2/stacks/STACK_ID/automation-settings \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "rules": [ { "rule_key": "0197c8f2-5a6b-7cde-8f12-3456789abcde", "type": "STATUS", "is_enabled": true, "trigger": "TEXT_CREATED_OR_UPDATED", "scope": { "origin": "IMPORT", "role": "TARGET", "language_codes": [ "de", "fr" ] }, "conditions": [], "action": { "type": "SET_STATUS", "target": { "selector": "TRIGGERING_TEXT", "language_codes": [], "conditions": [] }, "status": "APPROVED" } } ]}'import requests
url = "https://api.lingohub.com/v2/stacks/STACK_ID/automation-settings"
payload = { "rules": [ { "rule_key": "0197c8f2-5a6b-7cde-8f12-3456789abcde", "type": "STATUS", "is_enabled": True, "trigger": "TEXT_CREATED_OR_UPDATED", "scope": { "origin": "IMPORT", "role": "TARGET", "language_codes": ["de", "fr"] }, "conditions": [], "action": { "type": "SET_STATUS", "target": { "selector": "TRIGGERING_TEXT", "language_codes": [], "conditions": [] }, "status": "APPROVED" } } ] }headers = { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v2/stacks/STACK_ID/automation-settings';const options = { method: 'PUT', headers: {Authorization: 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json'}, body: '{"rules":[{"rule_key":"0197c8f2-5a6b-7cde-8f12-3456789abcde","type":"STATUS","is_enabled":true,"trigger":"TEXT_CREATED_OR_UPDATED","scope":{"origin":"IMPORT","role":"TARGET","language_codes":["de","fr"]},"conditions":[],"action":{"type":"SET_STATUS","target":{"selector":"TRIGGERING_TEXT","language_codes":[],"conditions":[]},"status":"APPROVED"}}]}'};
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/stacks/STACK_ID/automation-settings"
payload := strings.NewReader("{\n \"rules\": [\n {\n \"rule_key\": \"0197c8f2-5a6b-7cde-8f12-3456789abcde\",\n \"type\": \"STATUS\",\n \"is_enabled\": true,\n \"trigger\": \"TEXT_CREATED_OR_UPDATED\",\n \"scope\": {\n \"origin\": \"IMPORT\",\n \"role\": \"TARGET\",\n \"language_codes\": [\n \"de\",\n \"fr\"\n ]\n },\n \"conditions\": [],\n \"action\": {\n \"type\": \"SET_STATUS\",\n \"target\": {\n \"selector\": \"TRIGGERING_TEXT\",\n \"language_codes\": [],\n \"conditions\": []\n },\n \"status\": \"APPROVED\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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, "{\n \"rules\": [\n {\n \"rule_key\": \"0197c8f2-5a6b-7cde-8f12-3456789abcde\",\n \"type\": \"STATUS\",\n \"is_enabled\": true,\n \"trigger\": \"TEXT_CREATED_OR_UPDATED\",\n \"scope\": {\n \"origin\": \"IMPORT\",\n \"role\": \"TARGET\",\n \"language_codes\": [\n \"de\",\n \"fr\"\n ]\n },\n \"conditions\": [],\n \"action\": {\n \"type\": \"SET_STATUS\",\n \"target\": {\n \"selector\": \"TRIGGERING_TEXT\",\n \"language_codes\": [],\n \"conditions\": []\n },\n \"status\": \"APPROVED\"\n }\n }\n ]\n}");Request request = new Request.Builder() .url("https://api.lingohub.com/v2/stacks/STACK_ID/automation-settings") .put(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('PUT', 'https://api.lingohub.com/v2/stacks/STACK_ID/automation-settings', [ 'body' => '{ "rules": [ { "rule_key": "0197c8f2-5a6b-7cde-8f12-3456789abcde", "type": "STATUS", "is_enabled": true, "trigger": "TEXT_CREATED_OR_UPDATED", "scope": { "origin": "IMPORT", "role": "TARGET", "language_codes": [ "de", "fr" ] }, "conditions": [], "action": { "type": "SET_STATUS", "target": { "selector": "TRIGGERING_TEXT", "language_codes": [], "conditions": [] }, "status": "APPROVED" } } ]}', '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/stacks/STACK_ID/automation-settings")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Put.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'request["Content-Type"] = 'application/json'request.body = "{\n \"rules\": [\n {\n \"rule_key\": \"0197c8f2-5a6b-7cde-8f12-3456789abcde\",\n \"type\": \"STATUS\",\n \"is_enabled\": true,\n \"trigger\": \"TEXT_CREATED_OR_UPDATED\",\n \"scope\": {\n \"origin\": \"IMPORT\",\n \"role\": \"TARGET\",\n \"language_codes\": [\n \"de\",\n \"fr\"\n ]\n },\n \"conditions\": [],\n \"action\": {\n \"type\": \"SET_STATUS\",\n \"target\": {\n \"selector\": \"TRIGGERING_TEXT\",\n \"language_codes\": [],\n \"conditions\": []\n },\n \"status\": \"APPROVED\"\n }\n }\n ]\n}"
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Put, RequestUri = new Uri("https://api.lingohub.com/v2/stacks/STACK_ID/automation-settings"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, }, Content = new StringContent("{\n \"rules\": [\n {\n \"rule_key\": \"0197c8f2-5a6b-7cde-8f12-3456789abcde\",\n \"type\": \"STATUS\",\n \"is_enabled\": true,\n \"trigger\": \"TEXT_CREATED_OR_UPDATED\",\n \"scope\": {\n \"origin\": \"IMPORT\",\n \"role\": \"TARGET\",\n \"language_codes\": [\n \"de\",\n \"fr\"\n ]\n },\n \"conditions\": [],\n \"action\": {\n \"type\": \"SET_STATUS\",\n \"target\": {\n \"selector\": \"TRIGGERING_TEXT\",\n \"language_codes\": [],\n \"conditions\": []\n },\n \"status\": \"APPROVED\"\n }\n }\n ]\n}") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}Replaces all automation rules of the stack with the given list, in order; an empty list removes them all. Send a rule’s rule_key to keep its identity; new rules get one. The number of rules is limited by the plan (max_rules). Saving doesn’t run the rules on existing content. Requires stack-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 stack, a valid value would be : stack_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 replace the automation settings of a stack.
object
All rules of the stack, in order. An empty list removes every rule; at most max_rules rules.
Request body to replace the corresponding automation rule configuration.
object
Existing configuration key preserves identity. Null, omitted or unknown keys get a new server-generated key.
Example
0197c8f2-5a6b-7cde-8f12-3456789abcdeHow the rule’s group runs. TEXT: every matching rule applies, in list order, so the replacements chain. STATUS: the first matching rule wins. LABEL: every matching rule applies.
Example
STATUSWhether the rule is enabled. Disabled rules are still validated.
Example
trueIncoming event that can trigger this rule.
Example
TEXT_UPDATEDOrigin, role and language selection.
object
Incoming change origin.
Example
ANYSource or target text role.
Example
ANYEmpty selects every language; only meaningful for text-level triggers.
Example
[]All trigger conditions must match.
Request body to replace the corresponding automation rule configuration.
object
Subject inspected by the condition.
Example
TEXTPlain-text matching mode, never a regular expression.
Example
CONTAINSCondition text; absent or null when the mode needs no text.
Example
draftExample
[ { "subject": "TEXT", "mode": "CONTAINS", "value": "draft" }]What the rule does and to which texts. Its type must follow from the rule’s type: TEXT → REPLACE_TEXT, STATUS → SET_STATUS, LABEL → ADD_LABEL.
Request body to replace every occurrence of search in the text with replace.
object
Selects this shape of the body.
Example
REPLACE_TEXTThe texts the action changes; a text rule changes the triggering text.
object
Act on the triggering text or matching target texts.
Example
TRIGGERING_TEXTEmpty selects every target language; meaningful for SEGMENT_TARGET_TEXTS only.
Example
[]Conditions applied independently to each acted-on text.
Request body to replace the corresponding automation rule configuration.
object
Subject inspected by the condition.
Example
TEXTPlain-text matching mode, never a regular expression.
Example
CONTAINSCondition text; absent or null when the mode needs no text.
Example
draftExample
[ { "subject": "TEXT", "mode": "CONTAINS", "value": "draft" }]The plain text to search for, case-sensitively.
Example
colourThe replacement; an empty string deletes the found text.
Example
colorWhether placeholders in the text are left unchanged.
Example
trueRequest body to set the status of the texts.
object
Selects this shape of the body.
Example
SET_STATUSThe texts the action changes.
object
Act on the triggering text or matching target texts.
Example
TRIGGERING_TEXTEmpty selects every target language; meaningful for SEGMENT_TARGET_TEXTS only.
Example
[]Conditions applied independently to each acted-on text.
Request body to replace the corresponding automation rule configuration.
object
Subject inspected by the condition.
Example
TEXTPlain-text matching mode, never a regular expression.
Example
CONTAINSCondition text; absent or null when the mode needs no text.
Example
draftExample
[ { "subject": "TEXT", "mode": "CONTAINS", "value": "draft" }]The status to set. A rule that changes a source text can only set a status for source texts.
Example
APPROVEDRequest body to add a label to the segment.
object
Selects this shape of the body.
Example
ADD_LABELThe texts the action changes; a label rule changes the triggering text.
object
Act on the triggering text or matching target texts.
Example
TRIGGERING_TEXTEmpty selects every target language; meaningful for SEGMENT_TARGET_TEXTS only.
Example
[]Conditions applied independently to each acted-on text.
Request body to replace the corresponding automation rule configuration.
object
Subject inspected by the condition.
Example
TEXTPlain-text matching mode, never a regular expression.
Example
CONTAINSCondition text; absent or null when the mode needs no text.
Example
draftExample
[ { "subject": "TEXT", "mode": "CONTAINS", "value": "draft" }]A label of this workspace.
Example
la_0197c8f2-5a6b-7cde-8f12-3456789abcdeExample
[ { "rule_key": "0197c8f2-5a6b-7cde-8f12-3456789abcde", "type": "STATUS", "is_enabled": true, "trigger": "TEXT_CREATED_OR_UPDATED", "scope": { "origin": "IMPORT", "role": "TARGET", "language_codes": [ "de", "fr" ] }, "conditions": [], "action": { "type": "SET_STATUS", "target": { "selector": "TRIGGERING_TEXT", "language_codes": [], "conditions": [] }, "status": "APPROVED" } }]Responses
Section titled “Responses”Saved automation configuration. GET for the current ETag.
Current automation configuration of the stack, which applies to every project of it; not a simulation of effective behavior across the keys of shared segments.
object
Always STACK_AUTOMATION_SETTINGS.
Stack public identity addressing this singleton.
Complete ordered configuration. Evaluation runs TEXT, STATUS, LABEL families with order preserved within each family.
One rule in the ordered configuration of a stack; not a separately persisted V2 resource.
object
Stored UUID configuration key, stable across saves. Null preserves a historical missing key; reads never mint one.
How the rule’s group runs. TEXT: every matching rule applies, in list order, so the replacements chain. STATUS: the first matching rule wins. LABEL: every matching rule applies.
Whether this configured rule is enabled.
Incoming event that may trigger the rule.
Origin, text role and language selection.
object
IMPORT, EDITOR, or ANY. LINA/pretranslation bypass this workflow pipeline.
Source/target scope; meaningful only for text-level triggers.
Empty means every language; meaningful only for text-level triggers.
All trigger conditions must match.
A plain-text condition; conditions in one list must all match.
object
Subject inspected by the condition.
Plain-text matching mode. Regular expressions are not used.
Match text; null for conditions that require no text value.
What the rule does and to which texts. Its type follows from the rule’s type for now: TEXT → REPLACE_TEXT, STATUS → SET_STATUS, LABEL → ADD_LABEL.
Replaces every occurrence of search in the text with replace.
object
Selects this shape of the body.
The texts the action changes.
object
Act on the triggering text or matching target texts of its segment.
Empty means every target language; relevant for SEGMENT_TARGET_TEXTS.
Conditions checked per acted-on target text, separately from trigger conditions.
A plain-text condition; conditions in one list must all match.
object
Subject inspected by the condition.
Plain-text matching mode. Regular expressions are not used.
Match text; null for conditions that require no text value.
The plain text to search for, case-sensitively.
The replacement; an empty string deletes the found text.
Whether placeholders in the text are left unchanged.
Sets the status of the texts.
object
Selects this shape of the body.
The texts the action changes.
object
Act on the triggering text or matching target texts of its segment.
Empty means every target language; relevant for SEGMENT_TARGET_TEXTS.
Conditions checked per acted-on target text, separately from trigger conditions.
A plain-text condition; conditions in one list must all match.
object
Subject inspected by the condition.
Plain-text matching mode. Regular expressions are not used.
Match text; null for conditions that require no text value.
The status to set.
Adds a label to the segment.
object
Selects this shape of the body.
The texts the action changes.
object
Act on the triggering text or matching target texts of its segment.
Empty means every target language; relevant for SEGMENT_TARGET_TEXTS.
Conditions checked per acted-on target text, separately from trigger conditions.
A plain-text condition; conditions in one list must all match.
object
Subject inspected by the condition.
Plain-text matching mode. Regular expressions are not used.
Match text; null for conditions that require no text value.
The label to add; null when the label no longer exists in the workspace.
Current maximum number of rules allowed for the stack; does not truncate existing configuration.
Creation time of the stack settings row.
Last change to the stack settings row.
Example
{ "object_type": "STACK_AUTOMATION_SETTINGS", "id": "stack_0197c8f2-5a6b-7cde-8f12-3456789abcde", "rules": [ { "rule_key": "0197c8f2-5a6b-7cde-8f12-3456789abcde", "type": "STATUS", "is_enabled": true, "trigger": "TEXT_UPDATED", "scope": { "origin": "IMPORT", "role": "TARGET", "language_codes": [ "de" ] }, "conditions": [ { "subject": "TEXT", "mode": "CONTAINS", "value": "draft" } ], "action": { "type": "SET_STATUS", "target": { "selector": "TRIGGERING_TEXT", "language_codes": [], "conditions": [] }, "status": "APPROVED" } } ], "max_rules": 50, "created_at": "2026-09-30T00:00:00.123Z", "updated_at": "2026-09-30T00:00:00.123Z"}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 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 list has more rules than the plan allows (automation_limit_reached); max_rules is the limit.
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.