[{"data":1,"prerenderedAt":338},["ShallowReactive",2],{"navigation_docs_en":3,"-en-api-rest-api":110,"-en-api-rest-api-surround":333},[4,20,55,70,90,100],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":6},"Getting started",false,"\u002Fen\u002Fgetting-started","en\u002F1.getting-started",[10,15],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fen\u002Fgetting-started\u002Fintroduction","en\u002F1.getting-started\u002F1.introduction","i-lucide-house",{"title":16,"path":17,"stem":18,"icon":19},"Quickstart","\u002Fen\u002Fgetting-started\u002Fquickstart","en\u002F1.getting-started\u002F2.quickstart","i-lucide-rocket",{"title":21,"icon":6,"path":22,"stem":23,"children":24,"page":6},"Concepts","\u002Fen\u002Fconcepts","en\u002F2.concepts",[25,30,35,40,45,50],{"title":26,"path":27,"stem":28,"icon":29},"Projects and versions","\u002Fen\u002Fconcepts\u002Fprojects-and-versions","en\u002F2.concepts\u002F1.projects-and-versions","i-lucide-boxes",{"title":31,"path":32,"stem":33,"icon":34},"Config files","\u002Fen\u002Fconcepts\u002Ffiles","en\u002F2.concepts\u002F2.files","i-lucide-file-json",{"title":36,"path":37,"stem":38,"icon":39},"Publishing","\u002Fen\u002Fconcepts\u002Fpublishing","en\u002F2.concepts\u002F3.publishing","i-lucide-send",{"title":41,"path":42,"stem":43,"icon":44},"Access and roles","\u002Fen\u002Fconcepts\u002Faccess","en\u002F2.concepts\u002F4.access","i-lucide-users",{"title":46,"path":47,"stem":48,"icon":49},"Encryption","\u002Fen\u002Fconcepts\u002Fencryption","en\u002F2.concepts\u002F5.encryption","i-lucide-lock",{"title":51,"path":52,"stem":53,"icon":54},"Git integration","\u002Fen\u002Fconcepts\u002Fgit","en\u002F2.concepts\u002F6.git","i-lucide-git-branch",{"title":56,"icon":6,"path":57,"stem":58,"children":59,"page":6},"SDKs","\u002Fen\u002Fsdk","en\u002F3.sdk",[60,65],{"title":61,"path":62,"stem":63,"icon":64},"Node.js","\u002Fen\u002Fsdk\u002Fnodejs","en\u002F3.sdk\u002F1.nodejs","i-simple-icons-nodedotjs",{"title":66,"path":67,"stem":68,"icon":69},"Unity","\u002Fen\u002Fsdk\u002Funity","en\u002F3.sdk\u002F2.unity","i-simple-icons-unity",{"title":71,"icon":6,"path":72,"stem":73,"children":74,"page":6},"API and MCP","\u002Fen\u002Fapi","en\u002F4.api",[75,80,85],{"title":76,"path":77,"stem":78,"icon":79},"API tokens","\u002Fen\u002Fapi\u002Fauthentication","en\u002F4.api\u002F1.authentication","i-lucide-key-round",{"title":81,"path":82,"stem":83,"icon":84},"REST API","\u002Fen\u002Fapi\u002Frest-api","en\u002F4.api\u002F2.rest-api","i-lucide-plug",{"title":86,"path":87,"stem":88,"icon":89},"MCP for AI agents","\u002Fen\u002Fapi\u002Fmcp","en\u002F4.api\u002F3.mcp","i-lucide-bot",{"title":91,"icon":6,"path":92,"stem":93,"children":94,"page":6},"Support","\u002Fen\u002Fsupport","en\u002F5.support",[95],{"title":96,"path":97,"stem":98,"icon":99},"Feedback","\u002Fen\u002Fsupport\u002Ffeedback","en\u002F5.support\u002F1.feedback","i-lucide-message-circle",{"title":101,"icon":6,"path":102,"stem":103,"children":104,"page":6},"Legal","\u002Fen\u002Flegal","en\u002F6.legal",[105],{"title":106,"path":107,"stem":108,"icon":109},"Privacy policy","\u002Fen\u002Flegal\u002Fprivacy","en\u002F6.legal\u002F1.privacy","i-lucide-shield",{"id":111,"title":81,"body":112,"description":324,"extension":325,"links":326,"meta":327,"navigation":328,"path":82,"seo":329,"stem":83,"__hash__":332},"docs_en\u002Fen\u002F4.api\u002F2.rest-api.md",{"type":113,"value":114,"toc":313},"minimark",[115,129,136,140,145,215,219,257,263,274,277,281,292,296,306,310],[116,117,118,119,123,124,128],"p",{},"Base URL: ",[120,121,122],"code",{},"https:\u002F\u002F\u003Cyour-veresk-host>\u002Fapi\u002Fv1",". Authenticate with an ",[125,126,127],"a",{"href":77},"API token",".",[116,130,131,132,135],{},"The complete, always up-to-date reference with request and response schemas is served by your Veresk instance at ",[120,133,134],{},"\u002Fapi\u002Fv1\u002Fdocs"," (Swagger). This page explains how the pieces fit together.",[137,138,139],"note",{},"Projects are created and configured in the Veresk interface. The API works with existing projects.",[141,142,144],"h2",{"id":143},"endpoints","Endpoints",[146,147,148,161],"table",{},[149,150,151],"thead",{},[152,153,154,158],"tr",{},[155,156,157],"th",{},"Area",[155,159,160],{},"What you can do",[162,163,164,175,183,191,207],"tbody",{},[152,165,166,170],{},[167,168,169],"td",{},"Account",[167,171,172],{},[120,173,174],{},"GET \u002Fme",[152,176,177,180],{},[167,178,179],{},"Projects",[167,181,182],{},"List projects you can access; get one",[152,184,185,188],{},[167,186,187],{},"Versions",[167,189,190],{},"List, create from a parent, change the description, publish, compare two versions, copy files between versions",[152,192,193,196],{},[167,194,195],{},"Files",[167,197,198,199,202,203,206],{},"List (with ",[120,200,201],{},"search"," and ",[120,204,205],{},"tag"," filters), create, get metadata, rename or describe, read and write content per version, reset to the inherited content",[152,208,209,212],{},[167,210,211],{},"Consumers and tags",[167,213,214],{},"List consumers; list and create tags; assign a file to consumers and tags",[141,216,218],{"id":217},"typical-flow-change-a-value-and-publish","Typical flow: change a value and publish",[220,221,222,229,235,244,252],"ol",{},[223,224,225,228],"li",{},[120,226,227],{},"GET \u002Fprojects"," to find the project id.",[223,230,231,234],{},[120,232,233],{},"GET \u002Fprojects\u002F{projectId}\u002Ffiles?search=settings"," to find the file id.",[223,236,237,240,241,128],{},[120,238,239],{},"GET \u002Fprojects\u002F{projectId}\u002Ffiles\u002F{fileId}\u002Fversions\u002F{versionId}"," to read the content. Keep the returned ",[120,242,243],{},"etag",[223,245,246,249,250,128],{},[120,247,248],{},"PUT"," the same URL with the full new content and the ",[120,251,243],{},[223,253,254,128],{},[120,255,256],{},"POST \u002Fprojects\u002F{projectId}\u002Fversions\u002F{versionId}\u002Fpublish",[141,258,260,261],{"id":259},"safe-updates-with-etag","Safe updates with ",[120,262,243],{},[116,264,265,266,270,271,273],{},"Writing a file replaces its ",[267,268,269],"strong",{},"entire"," content in that version, and the version gets its own copy of the file. Pass the ",[120,272,243],{}," you received when reading. If someone changed the file in the meantime, the request fails with a conflict instead of overwriting their change.",[116,275,276],{},"JSON files take a JSON value; other files take a string. A locked version rejects writes.",[141,278,280],{"id":279},"inheritance-in-the-api","Inheritance in the API",[116,282,283,284,287,288,291],{},"Reading a file's content returns the content ",[267,285,286],{},"as served"," in that version: its own copy or the inherited one. The response says which version it actually comes from (",[120,289,290],{},"resolvedVersion",").",[141,293,295],{"id":294},"audit-trail","Audit trail",[116,297,298,299,202,302,305],{},"Files created or changed through the API get the tags ",[120,300,301],{},"api-created",[120,303,304],{},"api-edited",", so you can find what automation touched.",[141,307,309],{"id":308},"not-available-through-the-api","Not available through the API",[116,311,312],{},"For safety the public API cannot delete or create projects, change roles, regenerate the encryption key, or change Git, encryption flags or validation settings. Use the interface for these.",{"title":314,"searchDepth":315,"depth":315,"links":316},"",2,[317,318,319,321,322,323],{"id":143,"depth":315,"text":144},{"id":217,"depth":315,"text":218},{"id":259,"depth":315,"text":320},"Safe updates with etag",{"id":279,"depth":315,"text":280},{"id":294,"depth":315,"text":295},{"id":308,"depth":315,"text":309},"Manage versions, files and publishing over HTTP.","md",null,{},{"icon":84},{"title":330,"description":331},"Veresk REST API","Public REST API of Veresk under \u002Fapi\u002Fv1. Authentication, endpoint overview, safe file updates with etag and publishing to the CDN.","V2ZWqh9_2PZyngW1yzklNj3jQQyhd0cFQQn9jFruT18",[334,336],{"title":76,"path":77,"stem":78,"description":335,"icon":79,"children":-1},"Create a personal API token and authenticate REST and MCP requests.",{"title":86,"path":87,"stem":88,"description":337,"icon":89,"children":-1},"Connect an AI agent to Veresk over the Model Context Protocol.",1793977340584]