[{"data":1,"prerenderedAt":722},["ShallowReactive",2],{"page:\u002Fguides\u002Ferrors":3},{"id":4,"title":5,"apiPage":6,"body":7,"description":713,"extension":714,"layout":715,"meta":716,"navigation":717,"path":718,"playground":715,"seo":719,"stem":720,"__hash__":721},"docs\u002Fguides\u002Ferrors.md","Errors",false,{"type":8,"value":9,"toc":708},"minimark",[10,14,23,93,143,149,223,228,235,252,255,259,378,382,385,704],[11,12,5],"h1",{"id":13},"errors",[15,16,17,18,22],"p",{},"A failed request returns an HTTP error status and an ",[19,20,21],"code",{},"error"," object:",[24,25,30],"pre",{"className":26,"code":27,"language":28,"meta":29,"style":29},"language-json shiki shiki-themes ayu-light ayu-light ayu-dark","{\n  \"error\": {\n    \"code\": \"PROJECT_NOT_FOUND_EXCEPTION\",\n    \"message\": \"Project not found.\"\n  }\n}\n","json","",[19,31,32,41,55,70,81,87],{"__ignoreMap":29},[33,34,37],"span",{"class":35,"line":36},"line",1,[33,38,40],{"class":39},"snvv_","{\n",[33,42,44,48,52],{"class":35,"line":43},2,[33,45,47],{"class":46},"soLcz","  \"error\"",[33,49,51],{"class":50},"sgRSP",":",[33,53,54],{"class":39}," {\n",[33,56,58,61,63,67],{"class":35,"line":57},3,[33,59,60],{"class":46},"    \"code\"",[33,62,51],{"class":50},[33,64,66],{"class":65},"sHwJV"," \"PROJECT_NOT_FOUND_EXCEPTION\"",[33,68,69],{"class":50},",\n",[33,71,73,76,78],{"class":35,"line":72},4,[33,74,75],{"class":46},"    \"message\"",[33,77,51],{"class":50},[33,79,80],{"class":65}," \"Project not found.\"\n",[33,82,84],{"class":35,"line":83},5,[33,85,86],{"class":39},"  }\n",[33,88,90],{"class":35,"line":89},6,[33,91,92],{"class":39},"}\n",[94,95,96,109],"table",{},[97,98,99],"thead",{},[100,101,102,106],"tr",{},[103,104,105],"th",{},"Field",[103,107,108],{},"Description",[110,111,112,123,133],"tbody",{},[100,113,114,120],{},[115,116,117],"td",{},[19,118,119],{},"error.code",[115,121,122],{},"Error code. It is the same in every language, so branch on this value",[100,124,125,130],{},[115,126,127],{},[19,128,129],{},"error.message",[115,131,132],{},"Description you can show to users",[100,134,135,140],{},[115,136,137],{},[19,138,139],{},"error.details",[115,141,142],{},"Extra information, only for some errors",[15,144,145,146,51],{},"For example, an invalid request body names the first invalid field in ",[19,147,148],{},"error.details.property",[24,150,152],{"className":26,"code":151,"language":28,"meta":29,"style":29},"{\n  \"error\": {\n    \"code\": \"INVALID_REQUEST_BODY_EXCEPTION\",\n    \"message\": \"The request contains an invalid value.\",\n    \"details\": {\n      \"property\": \"keyword\"\n    }\n  }\n}\n",[19,153,154,158,166,177,188,197,207,213,218],{"__ignoreMap":29},[33,155,156],{"class":35,"line":36},[33,157,40],{"class":39},[33,159,160,162,164],{"class":35,"line":43},[33,161,47],{"class":46},[33,163,51],{"class":50},[33,165,54],{"class":39},[33,167,168,170,172,175],{"class":35,"line":57},[33,169,60],{"class":46},[33,171,51],{"class":50},[33,173,174],{"class":65}," \"INVALID_REQUEST_BODY_EXCEPTION\"",[33,176,69],{"class":50},[33,178,179,181,183,186],{"class":35,"line":72},[33,180,75],{"class":46},[33,182,51],{"class":50},[33,184,185],{"class":65}," \"The request contains an invalid value.\"",[33,187,69],{"class":50},[33,189,190,193,195],{"class":35,"line":83},[33,191,192],{"class":46},"    \"details\"",[33,194,51],{"class":50},[33,196,54],{"class":39},[33,198,199,202,204],{"class":35,"line":89},[33,200,201],{"class":46},"      \"property\"",[33,203,51],{"class":50},[33,205,206],{"class":65}," \"keyword\"\n",[33,208,210],{"class":35,"line":209},7,[33,211,212],{"class":39},"    }\n",[33,214,216],{"class":35,"line":215},8,[33,217,86],{"class":39},[33,219,221],{"class":35,"line":220},9,[33,222,92],{"class":39},[224,225,227],"h2",{"id":226},"request-id","Request ID",[15,229,230,231,234],{},"Every response includes an ",[19,232,233],{},"X-YouViCo-Request-Id"," header with a 32-character hexadecimal ID:",[24,236,240],{"className":237,"code":238,"language":239,"meta":29,"style":29},"language-http shiki shiki-themes ayu-light ayu-light ayu-dark","X-YouViCo-Request-Id: 4bf92f3577b34da6a3ce929d0e0e4736\n","http",[19,241,242],{"__ignoreMap":29},[33,243,244,246,249],{"class":35,"line":36},[33,245,233],{"class":46},[33,247,51],{"class":248},"sfQum",[33,250,251],{"class":65}," 4bf92f3577b34da6a3ce929d0e0e4736\n",[15,253,254],{},"Log this value with failed requests, and you can include it when you report an error to us.",[224,256,258],{"id":257},"http-status-codes","HTTP status codes",[94,260,261,271],{},[97,262,263],{},[100,264,265,268],{},[103,266,267],{},"Status",[103,269,270],{},"Meaning",[110,272,273,283,293,303,313,323,333,343,358,368],{},[100,274,275,280],{},[115,276,277],{},[19,278,279],{},"400 Bad Request",[115,281,282],{},"A field is missing or invalid, or the cursor is malformed",[100,284,285,290],{},[115,286,287],{},[19,288,289],{},"401 Unauthorized",[115,291,292],{},"The API key or OAuth access token is missing, invalid, or expired",[100,294,295,300],{},[115,296,297],{},[19,298,299],{},"403 Forbidden",[115,301,302],{},"You do not have permission for this action",[100,304,305,310],{},[115,306,307],{},[19,308,309],{},"404 Not Found",[115,311,312],{},"The resource does not exist, or you cannot reach it",[100,314,315,320],{},[115,316,317],{},[19,318,319],{},"409 Conflict",[115,321,322],{},"The request conflicts with the current state, such as a duplicate reaction",[100,324,325,330],{},[115,326,327],{},[19,328,329],{},"413 Content Too Large",[115,331,332],{},"The request body is too large",[100,334,335,340],{},[115,336,337],{},[19,338,339],{},"415 Unsupported Media Type",[115,341,342],{},"The request body is not sent as JSON",[100,344,345,350],{},[115,346,347],{},[19,348,349],{},"429 Too Many Requests",[115,351,352,353],{},"You exceeded the ",[354,355,357],"a",{"href":356},"\u002Fguides\u002Frate-limits","rate limit",[100,359,360,365],{},[115,361,362],{},[19,363,364],{},"500 Internal Server Error",[115,366,367],{},"Something went wrong on our side",[100,369,370,375],{},[115,371,372],{},[19,373,374],{},"503 Service Unavailable",[115,376,377],{},"The service is under maintenance",[224,379,381],{"id":380},"common-error-codes","Common error codes",[15,383,384],{},"These can occur on any endpoint.",[94,386,387,399],{},[97,388,389],{},[100,390,391,394,396],{},[103,392,393],{},"Code",[103,395,267],{},[103,397,398],{},"When it occurs",[110,400,401,416,430,452,467,481,496,515,529,543,557,571,585,600,614,628,646,661,676,690],{},[100,402,403,408,413],{},[115,404,405],{},[19,406,407],{},"INVALID_REQUEST_BODY_EXCEPTION",[115,409,410],{},[19,411,412],{},"400",[115,414,415],{},"The request body is invalid, or a cursor is malformed",[100,417,418,423,427],{},[115,419,420],{},[19,421,422],{},"INVALID_REQUEST_EXCEPTION",[115,424,425],{},[19,426,412],{},[115,428,429],{},"The request is invalid",[100,431,432,437,441],{},[115,433,434],{},[19,435,436],{},"INVALID_AUTHENTICATION_HEADER_EXCEPTION",[115,438,439],{},[19,440,412],{},[115,442,443,444,447,448,451],{},"The ",[19,445,446],{},"Authorization"," header is not in the ",[19,449,450],{},"Bearer YOUR_API_KEY"," format",[100,453,454,459,464],{},[115,455,456],{},[19,457,458],{},"INVALID_API_KEY_EXCEPTION",[115,460,461],{},[19,462,463],{},"401",[115,465,466],{},"The API key does not exist or is no longer active",[100,468,469,474,478],{},[115,470,471],{},[19,472,473],{},"INVALID_ACCESS_TOKEN_EXCEPTION",[115,475,476],{},[19,477,463],{},[115,479,480],{},"The OAuth access token is invalid or has expired",[100,482,483,488,493],{},[115,484,485],{},[19,486,487],{},"ACCESS_DENIED_EXCEPTION",[115,489,490],{},[19,491,492],{},"403",[115,494,495],{},"You do not have access to the resource",[100,497,498,503,507],{},[115,499,500],{},[19,501,502],{},"FORBIDDEN_SCOPE_EXCEPTION",[115,504,505],{},[19,506,492],{},[115,508,509,510,514],{},"The key or connection lacks the ",[354,511,513],{"href":512},"\u002Fguides\u002Fpermissions#scopes","scope"," the endpoint needs",[100,516,517,522,526],{},[115,518,519],{},[19,520,521],{},"FORBIDDEN_ROLE_EXCEPTION",[115,523,524],{},[19,525,492],{},[115,527,528],{},"Your role does not allow this action",[100,530,531,536,540],{},[115,532,533],{},[19,534,535],{},"USER_SUSPENDED_EXCEPTION",[115,537,538],{},[19,539,492],{},[115,541,542],{},"The account is suspended",[100,544,545,550,554],{},[115,546,547],{},[19,548,549],{},"NOT_IN_WORKSPACE_EXCEPTION",[115,551,552],{},[19,553,492],{},[115,555,556],{},"You are not a member of the workspace",[100,558,559,564,568],{},[115,560,561],{},[19,562,563],{},"FORBIDDEN_STATUS_EXCEPTION",[115,565,566],{},[19,567,492],{},[115,569,570],{},"The workspace member is inactive",[100,572,573,578,582],{},[115,574,575],{},[19,576,577],{},"PROJECT_ARCHIVED_EXCEPTION",[115,579,580],{},[19,581,492],{},[115,583,584],{},"The project is archived and cannot be changed",[100,586,587,592,597],{},[115,588,589],{},[19,590,591],{},"ROUTE_NOT_FOUND_EXCEPTION",[115,593,594],{},[19,595,596],{},"404",[115,598,599],{},"The URL path is not an endpoint",[100,601,602,607,611],{},[115,603,604],{},[19,605,606],{},"WORKSPACE_NOT_FOUND_EXCEPTION",[115,608,609],{},[19,610,596],{},[115,612,613],{},"The workspace does not exist",[100,615,616,621,626],{},[115,617,618],{},[19,619,620],{},"REQUEST_BODY_SIZE_LIMIT_EXCEEDED_EXCEPTION",[115,622,623],{},[19,624,625],{},"413",[115,627,332],{},[100,629,630,635,640],{},[115,631,632],{},[19,633,634],{},"UNSUPPORTED_CONTENT_TYPE_EXCEPTION",[115,636,637],{},[19,638,639],{},"415",[115,641,642,643],{},"The request body is not sent as ",[19,644,645],{},"application\u002Fjson",[100,647,648,653,658],{},[115,649,650],{},[19,651,652],{},"RATE_LIMIT_EXCEEDED_EXCEPTION",[115,654,655],{},[19,656,657],{},"429",[115,659,660],{},"You exceeded the endpoint's rate limit",[100,662,663,668,673],{},[115,664,665],{},[19,666,667],{},"INTERNAL_UNEXPECTED_EXCEPTION",[115,669,670],{},[19,671,672],{},"500",[115,674,675],{},"An unexpected server error occurred",[100,677,678,683,687],{},[115,679,680],{},[19,681,682],{},"DATABASE_UNAVAILABLE_EXCEPTION",[115,684,685],{},[19,686,672],{},[115,688,689],{},"The request cannot be processed right now. Try again later",[100,691,692,697,702],{},[115,693,694],{},[19,695,696],{},"SERVICE_MAINTENANCE_EXCEPTION",[115,698,699],{},[19,700,701],{},"503",[115,703,377],{},[705,706,707],"style",{},"html pre.shiki code .snvv_, html code.shiki .snvv_{--shiki-light:#5C6166;--shiki-default:#5C6166;--shiki-dark:#BFBDB6}html pre.shiki code .soLcz, html code.shiki .soLcz{--shiki-light:#55B4D4;--shiki-default:#55B4D4;--shiki-dark:#39BAE6}html pre.shiki code .sgRSP, html code.shiki .sgRSP{--shiki-light:#5C6166B3;--shiki-default:#5C6166B3;--shiki-dark:#BFBDB6B3}html pre.shiki code .sHwJV, html code.shiki .sHwJV{--shiki-light:#86B300;--shiki-default:#86B300;--shiki-dark:#AAD94C}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sfQum, html code.shiki .sfQum{--shiki-light:#FA8532;--shiki-default:#FA8532;--shiki-dark:#FF8F40}",{"title":29,"searchDepth":72,"depth":72,"links":709},[710,711,712],{"id":226,"depth":43,"text":227},{"id":257,"depth":43,"text":258},{"id":380,"depth":43,"text":381},"A failed request returns an HTTP error status and an error object with a code and a message.","md",null,{},true,"\u002Fguides\u002Ferrors",{"title":5,"description":713},"guides\u002Ferrors","iBdCOXT8_UGnA8QIi2fMntKVSCbHzaiCzU9yBOkese4",1792305905070]