[{"data":1,"prerenderedAt":963},["ShallowReactive",2],{"\u002Fdocs\u002Fapi":3},{"_path":4,"_dir":5,"_draft":6,"_partial":6,"_locale":7,"title":8,"description":9,"body":10,"_type":957,"_id":958,"_source":959,"_file":960,"_stem":961,"_extension":962},"\u002Fdocs\u002Fapi","docs",false,"","API guide","Everything in i3deploy — deploys, projects, services, and releases — is available over a plain\nREST API at https:\u002F\u002Fbackend.i3deploy.com. This page covers auth and the key endpoints; for the\nfull interactive reference, see:",{"type":11,"children":12,"toc":937},"root",[13,21,36,74,81,86,145,171,183,189,202,289,310,330,411,429,510,522,603,615,696,709,728,741,815,842,854,896,906,912,931],{"type":14,"tag":15,"props":16,"children":18},"element","h1",{"id":17},"api-guide",[19],{"type":20,"value":8},"text",{"type":14,"tag":22,"props":23,"children":24},"p",{},[25,27,34],{"type":20,"value":26},"Everything in i3deploy — deploys, projects, services, and releases — is available over a plain\nREST API at ",{"type":14,"tag":28,"props":29,"children":31},"code",{"className":30},[],[32],{"type":20,"value":33},"https:\u002F\u002Fbackend.i3deploy.com",{"type":20,"value":35},". This page covers auth and the key endpoints; for the\nfull interactive reference, see:",{"type":14,"tag":37,"props":38,"children":39},"ul",{},[40,59],{"type":14,"tag":41,"props":42,"children":43},"li",{},[44,57],{"type":14,"tag":45,"props":46,"children":47},"strong",{},[48],{"type":14,"tag":49,"props":50,"children":54},"a",{"href":51,"rel":52},"https:\u002F\u002Fbackend.i3deploy.com\u002Fschema\u002Fswagger\u002F",[53],"nofollow",[55],{"type":20,"value":56},"Swagger UI",{"type":20,"value":58}," — browse every endpoint, try\nrequests from the browser.",{"type":14,"tag":41,"props":60,"children":61},{},[62,72],{"type":14,"tag":45,"props":63,"children":64},{},[65],{"type":14,"tag":49,"props":66,"children":69},{"href":67,"rel":68},"https:\u002F\u002Fbackend.i3deploy.com\u002Fschema\u002Fredoc\u002F",[53],[70],{"type":20,"value":71},"Redoc",{"type":20,"value":73}," — the same schema as a static, readable\nreference doc.",{"type":14,"tag":75,"props":76,"children":78},"h2",{"id":77},"auth",[79],{"type":20,"value":80},"Auth",{"type":14,"tag":22,"props":82,"children":83},{},[84],{"type":20,"value":85},"Every request needs an API key, sent as a bearer token:",{"type":14,"tag":87,"props":88,"children":92},"pre",{"className":89,"code":90,"language":91,"meta":7,"style":7},"language-bash shiki shiki-themes github-dark","curl https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fdeploys \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\"\n","bash",[93],{"type":14,"tag":28,"props":94,"children":95},{"__ignoreMap":7},[96,120],{"type":14,"tag":97,"props":98,"children":101},"span",{"class":99,"line":100},"line",1,[102,108,114],{"type":14,"tag":97,"props":103,"children":105},{"style":104},"--shiki-default:#B392F0",[106],{"type":20,"value":107},"curl",{"type":14,"tag":97,"props":109,"children":111},{"style":110},"--shiki-default:#9ECBFF",[112],{"type":20,"value":113}," https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fdeploys",{"type":14,"tag":97,"props":115,"children":117},{"style":116},"--shiki-default:#79B8FF",[118],{"type":20,"value":119}," \\\n",{"type":14,"tag":97,"props":121,"children":123},{"class":99,"line":122},2,[124,129,134,140],{"type":14,"tag":97,"props":125,"children":126},{"style":116},[127],{"type":20,"value":128},"  -H",{"type":14,"tag":97,"props":130,"children":131},{"style":110},[132],{"type":20,"value":133}," \"Authorization: Bearer ",{"type":14,"tag":97,"props":135,"children":137},{"style":136},"--shiki-default:#E1E4E8",[138],{"type":20,"value":139},"$I3DEPLOY_API_KEY",{"type":14,"tag":97,"props":141,"children":142},{"style":110},[143],{"type":20,"value":144},"\"\n",{"type":14,"tag":22,"props":146,"children":147},{},[148,150,155,157,163,165,169],{"type":20,"value":149},"Create a key from the ",{"type":14,"tag":45,"props":151,"children":152},{},[153],{"type":20,"value":154},"API Keys",{"type":20,"value":156}," page in the app (",{"type":14,"tag":28,"props":158,"children":160},{"className":159},[],[161],{"type":20,"value":162},"app.i3deploy.com",{"type":20,"value":164}," → your org → ",{"type":14,"tag":45,"props":166,"children":167},{},[168],{"type":20,"value":154},{"type":20,"value":170},").\nThe key is shown once at creation time — copy it somewhere safe.",{"type":14,"tag":22,"props":172,"children":173},{},[174,176,181],{"type":20,"value":175},"Keys are ",{"type":14,"tag":45,"props":177,"children":178},{},[179],{"type":20,"value":180},"org-scoped",{"type":20,"value":182},", not user-scoped: whichever organization the key belongs to is the only\none it can read or write. There's no separate \"project\" or \"service\" scope — one key covers every\nproject and service in the org, so one key per CI system or integration is usually enough.",{"type":14,"tag":75,"props":184,"children":186},{"id":185},"key-endpoints",[187],{"type":20,"value":188},"Key endpoints",{"type":14,"tag":190,"props":191,"children":193},"h3",{"id":192},"post-v1deploys-start-a-deploy",[194,200],{"type":14,"tag":28,"props":195,"children":197},{"className":196},[],[198],{"type":20,"value":199},"POST \u002Fv1\u002Fdeploys",{"type":20,"value":201}," — start a deploy",{"type":14,"tag":87,"props":203,"children":205},{"className":89,"code":204,"language":91,"meta":7,"style":7},"curl -X POST https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fdeploys \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"service\":\"web\",\"env\":\"production\",\"version\":\"1.4.2\",\"commit_sha\":\"abc123\"}'\n",[206],{"type":14,"tag":28,"props":207,"children":208},{"__ignoreMap":7},[209,234,258,275],{"type":14,"tag":97,"props":210,"children":211},{"class":99,"line":100},[212,216,221,226,230],{"type":14,"tag":97,"props":213,"children":214},{"style":104},[215],{"type":20,"value":107},{"type":14,"tag":97,"props":217,"children":218},{"style":116},[219],{"type":20,"value":220}," -X",{"type":14,"tag":97,"props":222,"children":223},{"style":110},[224],{"type":20,"value":225}," POST",{"type":14,"tag":97,"props":227,"children":228},{"style":110},[229],{"type":20,"value":113},{"type":14,"tag":97,"props":231,"children":232},{"style":116},[233],{"type":20,"value":119},{"type":14,"tag":97,"props":235,"children":236},{"class":99,"line":122},[237,241,245,249,254],{"type":14,"tag":97,"props":238,"children":239},{"style":116},[240],{"type":20,"value":128},{"type":14,"tag":97,"props":242,"children":243},{"style":110},[244],{"type":20,"value":133},{"type":14,"tag":97,"props":246,"children":247},{"style":136},[248],{"type":20,"value":139},{"type":14,"tag":97,"props":250,"children":251},{"style":110},[252],{"type":20,"value":253},"\"",{"type":14,"tag":97,"props":255,"children":256},{"style":116},[257],{"type":20,"value":119},{"type":14,"tag":97,"props":259,"children":261},{"class":99,"line":260},3,[262,266,271],{"type":14,"tag":97,"props":263,"children":264},{"style":116},[265],{"type":20,"value":128},{"type":14,"tag":97,"props":267,"children":268},{"style":110},[269],{"type":20,"value":270}," \"Content-Type: application\u002Fjson\"",{"type":14,"tag":97,"props":272,"children":273},{"style":116},[274],{"type":20,"value":119},{"type":14,"tag":97,"props":276,"children":278},{"class":99,"line":277},4,[279,284],{"type":14,"tag":97,"props":280,"children":281},{"style":116},[282],{"type":20,"value":283},"  -d",{"type":14,"tag":97,"props":285,"children":286},{"style":110},[287],{"type":20,"value":288}," '{\"service\":\"web\",\"env\":\"production\",\"version\":\"1.4.2\",\"commit_sha\":\"abc123\"}'\n",{"type":14,"tag":22,"props":290,"children":291},{},[292,294,300,302,308],{"type":20,"value":293},"See the ",{"type":14,"tag":49,"props":295,"children":297},{"href":296},"\u002Fdocs\u002Fquickstart",[298],{"type":20,"value":299},"Quickstart",{"type":20,"value":301}," for the full start\u002Ffinish flow and the vendored\n",{"type":14,"tag":28,"props":303,"children":305},{"className":304},[],[306],{"type":20,"value":307},"i3deploy.sh",{"type":20,"value":309}," script.",{"type":14,"tag":190,"props":311,"children":313},{"id":312},"get-v1projects-list-projects-post-to-create-one",[314,320,322,328],{"type":14,"tag":28,"props":315,"children":317},{"className":316},[],[318],{"type":20,"value":319},"GET \u002Fv1\u002Fprojects",{"type":20,"value":321}," — list projects, ",{"type":14,"tag":28,"props":323,"children":325},{"className":324},[],[326],{"type":20,"value":327},"POST",{"type":20,"value":329}," to create one",{"type":14,"tag":87,"props":331,"children":333},{"className":89,"code":332,"language":91,"meta":7,"style":7},"curl -X POST https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fprojects \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"slug\":\"marketing-site\",\"title\":\"Marketing site\"}'\n",[334],{"type":14,"tag":28,"props":335,"children":336},{"__ignoreMap":7},[337,361,384,399],{"type":14,"tag":97,"props":338,"children":339},{"class":99,"line":100},[340,344,348,352,357],{"type":14,"tag":97,"props":341,"children":342},{"style":104},[343],{"type":20,"value":107},{"type":14,"tag":97,"props":345,"children":346},{"style":116},[347],{"type":20,"value":220},{"type":14,"tag":97,"props":349,"children":350},{"style":110},[351],{"type":20,"value":225},{"type":14,"tag":97,"props":353,"children":354},{"style":110},[355],{"type":20,"value":356}," https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fprojects",{"type":14,"tag":97,"props":358,"children":359},{"style":116},[360],{"type":20,"value":119},{"type":14,"tag":97,"props":362,"children":363},{"class":99,"line":122},[364,368,372,376,380],{"type":14,"tag":97,"props":365,"children":366},{"style":116},[367],{"type":20,"value":128},{"type":14,"tag":97,"props":369,"children":370},{"style":110},[371],{"type":20,"value":133},{"type":14,"tag":97,"props":373,"children":374},{"style":136},[375],{"type":20,"value":139},{"type":14,"tag":97,"props":377,"children":378},{"style":110},[379],{"type":20,"value":253},{"type":14,"tag":97,"props":381,"children":382},{"style":116},[383],{"type":20,"value":119},{"type":14,"tag":97,"props":385,"children":386},{"class":99,"line":260},[387,391,395],{"type":14,"tag":97,"props":388,"children":389},{"style":116},[390],{"type":20,"value":128},{"type":14,"tag":97,"props":392,"children":393},{"style":110},[394],{"type":20,"value":270},{"type":14,"tag":97,"props":396,"children":397},{"style":116},[398],{"type":20,"value":119},{"type":14,"tag":97,"props":400,"children":401},{"class":99,"line":277},[402,406],{"type":14,"tag":97,"props":403,"children":404},{"style":116},[405],{"type":20,"value":283},{"type":14,"tag":97,"props":407,"children":408},{"style":110},[409],{"type":20,"value":410}," '{\"slug\":\"marketing-site\",\"title\":\"Marketing site\"}'\n",{"type":14,"tag":190,"props":412,"children":414},{"id":413},"get-v1services-list-services-post-to-create-one",[415,421,423,428],{"type":14,"tag":28,"props":416,"children":418},{"className":417},[],[419],{"type":20,"value":420},"GET \u002Fv1\u002Fservices",{"type":20,"value":422}," — list services, ",{"type":14,"tag":28,"props":424,"children":426},{"className":425},[],[427],{"type":20,"value":327},{"type":20,"value":329},{"type":14,"tag":87,"props":430,"children":432},{"className":89,"code":431,"language":91,"meta":7,"style":7},"curl -X POST https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fservices \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"slug\":\"web\",\"project\":\"marketing-site\",\"display_name\":\"Web\"}'\n",[433],{"type":14,"tag":28,"props":434,"children":435},{"__ignoreMap":7},[436,460,483,498],{"type":14,"tag":97,"props":437,"children":438},{"class":99,"line":100},[439,443,447,451,456],{"type":14,"tag":97,"props":440,"children":441},{"style":104},[442],{"type":20,"value":107},{"type":14,"tag":97,"props":444,"children":445},{"style":116},[446],{"type":20,"value":220},{"type":14,"tag":97,"props":448,"children":449},{"style":110},[450],{"type":20,"value":225},{"type":14,"tag":97,"props":452,"children":453},{"style":110},[454],{"type":20,"value":455}," https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fservices",{"type":14,"tag":97,"props":457,"children":458},{"style":116},[459],{"type":20,"value":119},{"type":14,"tag":97,"props":461,"children":462},{"class":99,"line":122},[463,467,471,475,479],{"type":14,"tag":97,"props":464,"children":465},{"style":116},[466],{"type":20,"value":128},{"type":14,"tag":97,"props":468,"children":469},{"style":110},[470],{"type":20,"value":133},{"type":14,"tag":97,"props":472,"children":473},{"style":136},[474],{"type":20,"value":139},{"type":14,"tag":97,"props":476,"children":477},{"style":110},[478],{"type":20,"value":253},{"type":14,"tag":97,"props":480,"children":481},{"style":116},[482],{"type":20,"value":119},{"type":14,"tag":97,"props":484,"children":485},{"class":99,"line":260},[486,490,494],{"type":14,"tag":97,"props":487,"children":488},{"style":116},[489],{"type":20,"value":128},{"type":14,"tag":97,"props":491,"children":492},{"style":110},[493],{"type":20,"value":270},{"type":14,"tag":97,"props":495,"children":496},{"style":116},[497],{"type":20,"value":119},{"type":14,"tag":97,"props":499,"children":500},{"class":99,"line":277},[501,505],{"type":14,"tag":97,"props":502,"children":503},{"style":116},[504],{"type":20,"value":283},{"type":14,"tag":97,"props":506,"children":507},{"style":110},[508],{"type":20,"value":509}," '{\"slug\":\"web\",\"project\":\"marketing-site\",\"display_name\":\"Web\"}'\n",{"type":14,"tag":190,"props":511,"children":513},{"id":512},"post-v1service-releases-record-a-services-changelog",[514,520],{"type":14,"tag":28,"props":515,"children":517},{"className":516},[],[518],{"type":20,"value":519},"POST \u002Fv1\u002Fservice-releases",{"type":20,"value":521}," — record a service's changelog",{"type":14,"tag":87,"props":523,"children":525},{"className":89,"code":524,"language":91,"meta":7,"style":7},"curl -X POST https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fservice-releases \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"service\":\"web\",\"version\":\"1.4.2\",\"commit_sha\":\"abc123\",\"changelog_markdown\":\"- Fixed the checkout redirect loop\"}'\n",[526],{"type":14,"tag":28,"props":527,"children":528},{"__ignoreMap":7},[529,553,576,591],{"type":14,"tag":97,"props":530,"children":531},{"class":99,"line":100},[532,536,540,544,549],{"type":14,"tag":97,"props":533,"children":534},{"style":104},[535],{"type":20,"value":107},{"type":14,"tag":97,"props":537,"children":538},{"style":116},[539],{"type":20,"value":220},{"type":14,"tag":97,"props":541,"children":542},{"style":110},[543],{"type":20,"value":225},{"type":14,"tag":97,"props":545,"children":546},{"style":110},[547],{"type":20,"value":548}," https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fservice-releases",{"type":14,"tag":97,"props":550,"children":551},{"style":116},[552],{"type":20,"value":119},{"type":14,"tag":97,"props":554,"children":555},{"class":99,"line":122},[556,560,564,568,572],{"type":14,"tag":97,"props":557,"children":558},{"style":116},[559],{"type":20,"value":128},{"type":14,"tag":97,"props":561,"children":562},{"style":110},[563],{"type":20,"value":133},{"type":14,"tag":97,"props":565,"children":566},{"style":136},[567],{"type":20,"value":139},{"type":14,"tag":97,"props":569,"children":570},{"style":110},[571],{"type":20,"value":253},{"type":14,"tag":97,"props":573,"children":574},{"style":116},[575],{"type":20,"value":119},{"type":14,"tag":97,"props":577,"children":578},{"class":99,"line":260},[579,583,587],{"type":14,"tag":97,"props":580,"children":581},{"style":116},[582],{"type":20,"value":128},{"type":14,"tag":97,"props":584,"children":585},{"style":110},[586],{"type":20,"value":270},{"type":14,"tag":97,"props":588,"children":589},{"style":116},[590],{"type":20,"value":119},{"type":14,"tag":97,"props":592,"children":593},{"class":99,"line":277},[594,598],{"type":14,"tag":97,"props":595,"children":596},{"style":116},[597],{"type":20,"value":283},{"type":14,"tag":97,"props":599,"children":600},{"style":110},[601],{"type":20,"value":602}," '{\"service\":\"web\",\"version\":\"1.4.2\",\"commit_sha\":\"abc123\",\"changelog_markdown\":\"- Fixed the checkout redirect loop\"}'\n",{"type":14,"tag":190,"props":604,"children":606},{"id":605},"post-v1project-releases-bundle-service-releases-into-a-project-release",[607,613],{"type":14,"tag":28,"props":608,"children":610},{"className":609},[],[611],{"type":20,"value":612},"POST \u002Fv1\u002Fproject-releases",{"type":20,"value":614}," — bundle service releases into a project release",{"type":14,"tag":87,"props":616,"children":618},{"className":89,"code":617,"language":91,"meta":7,"style":7},"curl -X POST https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fproject-releases \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"project\":\"marketing-site\",\"title\":\"2.4\",\"version_numeric\":\"2.4.0\",\"markdown_users\":\"Fixed checkout\",\"service_releases\":[{\"service\":\"web\",\"version\":\"1.4.2\"}]}'\n",[619],{"type":14,"tag":28,"props":620,"children":621},{"__ignoreMap":7},[622,646,669,684],{"type":14,"tag":97,"props":623,"children":624},{"class":99,"line":100},[625,629,633,637,642],{"type":14,"tag":97,"props":626,"children":627},{"style":104},[628],{"type":20,"value":107},{"type":14,"tag":97,"props":630,"children":631},{"style":116},[632],{"type":20,"value":220},{"type":14,"tag":97,"props":634,"children":635},{"style":110},[636],{"type":20,"value":225},{"type":14,"tag":97,"props":638,"children":639},{"style":110},[640],{"type":20,"value":641}," https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fproject-releases",{"type":14,"tag":97,"props":643,"children":644},{"style":116},[645],{"type":20,"value":119},{"type":14,"tag":97,"props":647,"children":648},{"class":99,"line":122},[649,653,657,661,665],{"type":14,"tag":97,"props":650,"children":651},{"style":116},[652],{"type":20,"value":128},{"type":14,"tag":97,"props":654,"children":655},{"style":110},[656],{"type":20,"value":133},{"type":14,"tag":97,"props":658,"children":659},{"style":136},[660],{"type":20,"value":139},{"type":14,"tag":97,"props":662,"children":663},{"style":110},[664],{"type":20,"value":253},{"type":14,"tag":97,"props":666,"children":667},{"style":116},[668],{"type":20,"value":119},{"type":14,"tag":97,"props":670,"children":671},{"class":99,"line":260},[672,676,680],{"type":14,"tag":97,"props":673,"children":674},{"style":116},[675],{"type":20,"value":128},{"type":14,"tag":97,"props":677,"children":678},{"style":110},[679],{"type":20,"value":270},{"type":14,"tag":97,"props":681,"children":682},{"style":116},[683],{"type":20,"value":119},{"type":14,"tag":97,"props":685,"children":686},{"class":99,"line":277},[687,691],{"type":14,"tag":97,"props":688,"children":689},{"style":116},[690],{"type":20,"value":283},{"type":14,"tag":97,"props":692,"children":693},{"style":110},[694],{"type":20,"value":695}," '{\"project\":\"marketing-site\",\"title\":\"2.4\",\"version_numeric\":\"2.4.0\",\"markdown_users\":\"Fixed checkout\",\"service_releases\":[{\"service\":\"web\",\"version\":\"1.4.2\"}]}'\n",{"type":14,"tag":22,"props":697,"children":698},{},[699,701,707],{"type":20,"value":700},"See ",{"type":14,"tag":49,"props":702,"children":704},{"href":703},"\u002Fdocs\u002Freleases",[705],{"type":20,"value":706},"Cutting releases",{"type":20,"value":708}," for the full ServiceRelease\u002FProjectRelease model and field\nshapes.",{"type":14,"tag":190,"props":710,"children":712},{"id":711},"get-v1api-keys-list-your-orgs-keys-post-to-mint-one",[713,719,721,726],{"type":14,"tag":28,"props":714,"children":716},{"className":715},[],[717],{"type":20,"value":718},"GET \u002Fv1\u002Fapi-keys",{"type":20,"value":720}," — list your org's keys, ",{"type":14,"tag":28,"props":722,"children":724},{"className":723},[],[725],{"type":20,"value":327},{"type":20,"value":727}," to mint one",{"type":14,"tag":22,"props":729,"children":730},{},[731,733,739],{"type":20,"value":732},"Key management is one level up from everything else: it's only available to a logged-in user\naccount (never another API key — a limited key can't mint itself a broader one), and it takes an\n",{"type":14,"tag":28,"props":734,"children":736},{"className":735},[],[737],{"type":20,"value":738},"organization",{"type":20,"value":740}," query param to pick which org's keys you're managing:",{"type":14,"tag":87,"props":742,"children":744},{"className":89,"code":743,"language":91,"meta":7,"style":7},"curl -X POST \"https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fapi-keys?organization=acme-inc\" \\\n  -H \"Cookie: \u003Cyour session cookie>\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"name\":\"ci-pipeline\"}'\n",[745],{"type":14,"tag":28,"props":746,"children":747},{"__ignoreMap":7},[748,772,788,803],{"type":14,"tag":97,"props":749,"children":750},{"class":99,"line":100},[751,755,759,763,768],{"type":14,"tag":97,"props":752,"children":753},{"style":104},[754],{"type":20,"value":107},{"type":14,"tag":97,"props":756,"children":757},{"style":116},[758],{"type":20,"value":220},{"type":14,"tag":97,"props":760,"children":761},{"style":110},[762],{"type":20,"value":225},{"type":14,"tag":97,"props":764,"children":765},{"style":110},[766],{"type":20,"value":767}," \"https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Fapi-keys?organization=acme-inc\"",{"type":14,"tag":97,"props":769,"children":770},{"style":116},[771],{"type":20,"value":119},{"type":14,"tag":97,"props":773,"children":774},{"class":99,"line":122},[775,779,784],{"type":14,"tag":97,"props":776,"children":777},{"style":116},[778],{"type":20,"value":128},{"type":14,"tag":97,"props":780,"children":781},{"style":110},[782],{"type":20,"value":783}," \"Cookie: \u003Cyour session cookie>\"",{"type":14,"tag":97,"props":785,"children":786},{"style":116},[787],{"type":20,"value":119},{"type":14,"tag":97,"props":789,"children":790},{"class":99,"line":260},[791,795,799],{"type":14,"tag":97,"props":792,"children":793},{"style":116},[794],{"type":20,"value":128},{"type":14,"tag":97,"props":796,"children":797},{"style":110},[798],{"type":20,"value":270},{"type":14,"tag":97,"props":800,"children":801},{"style":116},[802],{"type":20,"value":119},{"type":14,"tag":97,"props":804,"children":805},{"class":99,"line":277},[806,810],{"type":14,"tag":97,"props":807,"children":808},{"style":116},[809],{"type":20,"value":283},{"type":14,"tag":97,"props":811,"children":812},{"style":110},[813],{"type":20,"value":814}," '{\"name\":\"ci-pipeline\"}'\n",{"type":14,"tag":22,"props":816,"children":817},{},[818,820,824,826,832,834,840],{"type":20,"value":819},"In practice you'll do this from the ",{"type":14,"tag":45,"props":821,"children":822},{},[823],{"type":20,"value":154},{"type":20,"value":825}," page in the app rather than curl. The response\nincludes the raw ",{"type":14,"tag":28,"props":827,"children":829},{"className":828},[],[830],{"type":20,"value":831},"secret",{"type":20,"value":833}," — that's the only time it's ever returned. Store it now; every later\n",{"type":14,"tag":28,"props":835,"children":837},{"className":836},[],[838],{"type":20,"value":839},"GET",{"type":20,"value":841}," on this endpoint omits it.",{"type":14,"tag":190,"props":843,"children":845},{"id":844},"get-v1organizations-the-orgs-your-key-or-account-can-see",[846,852],{"type":14,"tag":28,"props":847,"children":849},{"className":848},[],[850],{"type":20,"value":851},"GET \u002Fv1\u002Forganizations",{"type":20,"value":853}," — the orgs your key (or account) can see",{"type":14,"tag":87,"props":855,"children":857},{"className":89,"code":856,"language":91,"meta":7,"style":7},"curl https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Forganizations \\\n  -H \"Authorization: Bearer $I3DEPLOY_API_KEY\"\n",[858],{"type":14,"tag":28,"props":859,"children":860},{"__ignoreMap":7},[861,877],{"type":14,"tag":97,"props":862,"children":863},{"class":99,"line":100},[864,868,873],{"type":14,"tag":97,"props":865,"children":866},{"style":104},[867],{"type":20,"value":107},{"type":14,"tag":97,"props":869,"children":870},{"style":110},[871],{"type":20,"value":872}," https:\u002F\u002Fbackend.i3deploy.com\u002Fv1\u002Forganizations",{"type":14,"tag":97,"props":874,"children":875},{"style":116},[876],{"type":20,"value":119},{"type":14,"tag":97,"props":878,"children":879},{"class":99,"line":122},[880,884,888,892],{"type":14,"tag":97,"props":881,"children":882},{"style":116},[883],{"type":20,"value":128},{"type":14,"tag":97,"props":885,"children":886},{"style":110},[887],{"type":20,"value":133},{"type":14,"tag":97,"props":889,"children":890},{"style":136},[891],{"type":20,"value":139},{"type":14,"tag":97,"props":893,"children":894},{"style":110},[895],{"type":20,"value":144},{"type":14,"tag":22,"props":897,"children":898},{},[899,904],{"type":14,"tag":28,"props":900,"children":902},{"className":901},[],[903],{"type":20,"value":327},{"type":20,"value":905}," to this endpoint creates a new organization, but only for a logged-in user account, not an\nAPI key — it's tied to per-user ownership limits, so create new orgs from the app UI instead of\nCI.",{"type":14,"tag":75,"props":907,"children":909},{"id":908},"everything-else",[910],{"type":20,"value":911},"Everything else",{"type":14,"tag":22,"props":913,"children":914},{},[915,917,922,924,929],{"type":20,"value":916},"The list above covers what most integrations need. For the full set of endpoints, request\u002Fresponse\nshapes, and fields, use the ",{"type":14,"tag":49,"props":918,"children":920},{"href":51,"rel":919},[53],[921],{"type":20,"value":56},{"type":20,"value":923}," or\n",{"type":14,"tag":49,"props":925,"children":927},{"href":67,"rel":926},[53],[928],{"type":20,"value":71},{"type":20,"value":930}," — both are generated straight from the live\nschema, so they never drift from what the server actually accepts.",{"type":14,"tag":932,"props":933,"children":934},"style",{},[935],{"type":20,"value":936},"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);}",{"title":7,"searchDepth":122,"depth":122,"links":938},[939,940,956],{"id":77,"depth":122,"text":80},{"id":185,"depth":122,"text":188,"children":941},[942,944,946,948,950,952,954],{"id":192,"depth":260,"text":943},"POST \u002Fv1\u002Fdeploys — start a deploy",{"id":312,"depth":260,"text":945},"GET \u002Fv1\u002Fprojects — list projects, POST to create one",{"id":413,"depth":260,"text":947},"GET \u002Fv1\u002Fservices — list services, POST to create one",{"id":512,"depth":260,"text":949},"POST \u002Fv1\u002Fservice-releases — record a service's changelog",{"id":605,"depth":260,"text":951},"POST \u002Fv1\u002Fproject-releases — bundle service releases into a project release",{"id":711,"depth":260,"text":953},"GET \u002Fv1\u002Fapi-keys — list your org's keys, POST to mint one",{"id":844,"depth":260,"text":955},"GET \u002Fv1\u002Forganizations — the orgs your key (or account) can see",{"id":908,"depth":122,"text":911},"markdown","content:docs:api.md","content","docs\u002Fapi.md","docs\u002Fapi","md",1784716250634]