[{"data":1,"prerenderedAt":409},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fdevelopers\u002Fsdk":3,"docs-navigation":358,"docs-surround-\u002Fdocs\u002Fdevelopers\u002Fsdk":407},{"id":4,"title":5,"body":6,"description":349,"extension":350,"icon":351,"meta":352,"navigation":353,"path":354,"seo":355,"stem":356,"__hash__":357},"docs\u002Fdocs\u002F2.developers\u002F3.sdk.md","Node.js SDK",{"type":7,"value":8,"toc":343},"minimark",[9,13,17,57,62,88,92,244,252,256,263,316,326,330,339],[10,11,5],"h1",{"id":12},"nodejs-sdk",[14,15,16],"p",{},"The official Node.js \u002F TypeScript client for the Hostsmith Public API. Manage sites, deploy files, and list domains programmatically.",[18,19,20,35,45,51],"ul",{},[21,22,23,27,28],"li",{},[24,25,26],"strong",{},"npm:"," ",[29,30,34],"a",{"href":31,"rel":32},"https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002F@hostsmith\u002Fsdk",[33],"nofollow","@hostsmith\u002Fsdk",[21,36,37,27,40],{},[24,38,39],{},"Source:",[29,41,44],{"href":42,"rel":43},"https:\u002F\u002Fgithub.com\u002Fhostsmith\u002Fjs-sdk",[33],"hostsmith\u002Fjs-sdk",[21,46,47,50],{},[24,48,49],{},"License:"," MIT",[21,52,53,56],{},[24,54,55],{},"Node.js:"," 20 or later",[58,59,61],"h2",{"id":60},"install","Install",[63,64,69],"pre",{"className":65,"code":66,"language":67,"meta":68,"style":68},"language-bash shiki shiki-themes github-dark","npm install @hostsmith\u002Fsdk\n","bash","",[70,71,72],"code",{"__ignoreMap":68},[73,74,77,81,85],"span",{"class":75,"line":76},"line",1,[73,78,80],{"class":79},"svObZ","npm",[73,82,84],{"class":83},"sU2Wk"," install",[73,86,87],{"class":83}," @hostsmith\u002Fsdk\n",[58,89,91],{"id":90},"quick-start","Quick start",[63,93,97],{"className":94,"code":95,"language":96,"meta":68,"style":68},"language-ts shiki shiki-themes github-dark","import { Hostsmith } from \"@hostsmith\u002Fsdk\";\n\nconst client = new Hostsmith({\n  accessToken: process.env.HOSTSMITH_ACCESS_TOKEN!,\n  partition: \"us\", \u002F\u002F \"us\" or \"eu\"\n});\n\nconst { sites } = await client.sites.list();\nawait client.sites.deploy(sites[0].id, \".\u002Fdist\");\n","ts",[70,98,99,118,125,147,162,178,184,189,218],{"__ignoreMap":68},[73,100,101,105,109,112,115],{"class":75,"line":76},[73,102,104],{"class":103},"snl16","import",[73,106,108],{"class":107},"s95oV"," { Hostsmith } ",[73,110,111],{"class":103},"from",[73,113,114],{"class":83}," \"@hostsmith\u002Fsdk\"",[73,116,117],{"class":107},";\n",[73,119,121],{"class":75,"line":120},2,[73,122,124],{"emptyLinePlaceholder":123},true,"\n",[73,126,128,131,135,138,141,144],{"class":75,"line":127},3,[73,129,130],{"class":103},"const",[73,132,134],{"class":133},"sDLfK"," client",[73,136,137],{"class":103}," =",[73,139,140],{"class":103}," new",[73,142,143],{"class":79}," Hostsmith",[73,145,146],{"class":107},"({\n",[73,148,150,153,156,159],{"class":75,"line":149},4,[73,151,152],{"class":107},"  accessToken: process.env.",[73,154,155],{"class":133},"HOSTSMITH_ACCESS_TOKEN",[73,157,158],{"class":103},"!",[73,160,161],{"class":107},",\n",[73,163,165,168,171,174],{"class":75,"line":164},5,[73,166,167],{"class":107},"  partition: ",[73,169,170],{"class":83},"\"us\"",[73,172,173],{"class":107},", ",[73,175,177],{"class":176},"sAwPA","\u002F\u002F \"us\" or \"eu\"\n",[73,179,181],{"class":75,"line":180},6,[73,182,183],{"class":107},"});\n",[73,185,187],{"class":75,"line":186},7,[73,188,124],{"emptyLinePlaceholder":123},[73,190,192,194,197,200,203,206,209,212,215],{"class":75,"line":191},8,[73,193,130],{"class":103},[73,195,196],{"class":107}," { ",[73,198,199],{"class":133},"sites",[73,201,202],{"class":107}," } ",[73,204,205],{"class":103},"=",[73,207,208],{"class":103}," await",[73,210,211],{"class":107}," client.sites.",[73,213,214],{"class":79},"list",[73,216,217],{"class":107},"();\n",[73,219,221,224,226,229,232,235,238,241],{"class":75,"line":220},9,[73,222,223],{"class":103},"await",[73,225,211],{"class":107},[73,227,228],{"class":79},"deploy",[73,230,231],{"class":107},"(sites[",[73,233,234],{"class":133},"0",[73,236,237],{"class":107},"].id, ",[73,239,240],{"class":83},"\".\u002Fdist\"",[73,242,243],{"class":107},");\n",[14,245,246,247,251],{},"You'll need an OAuth access token - see ",[29,248,250],{"href":249},".\u002Fauthentication","Authentication"," for how to obtain one.",[58,253,255],{"id":254},"partitions","Partitions",[14,257,258,259,262],{},"Hostsmith stores data in regional partitions. Pass ",[70,260,261],{},"partition"," to the client to pick one:",[264,265,266,282],"table",{},[267,268,269],"thead",{},[270,271,272,276,279],"tr",{},[273,274,275],"th",{},"Partition",[273,277,278],{},"Label",[273,280,281],{},"Base URL",[283,284,285,301],"tbody",{},[270,286,287,293,296],{},[288,289,290],"td",{},[70,291,292],{},"us",[288,294,295],{},"United States",[288,297,298],{},[70,299,300],{},"https:\u002F\u002Fus.api.hostsmith.net",[270,302,303,308,311],{},[288,304,305],{},[70,306,307],{},"eu",[288,309,310],{},"European Union",[288,312,313],{},[70,314,315],{},"https:\u002F\u002Feu.api.hostsmith.net",[14,317,318,319,322,323,325],{},"If your token's ",[70,320,321],{},"aud"," claim names a single partition, you can omit ",[70,324,261],{}," and the SDK will default to it.",[58,327,329],{"id":328},"further-reading","Further reading",[14,331,332,333,338],{},"The full API reference, deploy flow, error classes, and dev\u002Fstaging overrides are documented in the ",[29,334,337],{"href":335,"rel":336},"https:\u002F\u002Fgithub.com\u002Fhostsmith\u002Fjs-sdk#readme",[33],"SDK README on GitHub",".",[340,341,342],"style",{},"html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}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 pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}",{"title":68,"searchDepth":120,"depth":120,"links":344},[345,346,347,348],{"id":60,"depth":120,"text":61},{"id":90,"depth":120,"text":91},{"id":254,"depth":120,"text":255},{"id":328,"depth":120,"text":329},"Official Node.js client for the Hostsmith Public API.","md","solar:code-square-bold",{},null,"\u002Fdocs\u002Fdevelopers\u002Fsdk",{"title":5,"description":349},"docs\u002F2.developers\u002F3.sdk","5qC14FFEsuxFZYIDJjBgnPPVL8Heuyd1YX-xJfZvEh8",[359],{"title":360,"path":361,"stem":362,"children":363,"page":406},"Docs","\u002Fdocs","docs",[364,391],{"title":365,"path":366,"stem":367,"children":368,"page":-1,"icon":370},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started\u002Findex",[369,371,375,379,383,387],{"title":365,"path":366,"stem":367,"icon":370},"solar:rocket-bold",{"title":372,"path":373,"stem":374},"Introduction","\u002Fdocs\u002Fgetting-started\u002Fintroduction","docs\u002F1.getting-started\u002F1.introduction",{"title":376,"path":377,"stem":378},"Quick Start","\u002Fdocs\u002Fgetting-started\u002Fquick-start","docs\u002F1.getting-started\u002F2.quick-start",{"title":380,"path":381,"stem":382},"Sites","\u002Fdocs\u002Fgetting-started\u002Fsites","docs\u002F1.getting-started\u002F3.sites",{"title":384,"path":385,"stem":386},"Custom Domains","\u002Fdocs\u002Fgetting-started\u002Fcustom-domains","docs\u002F1.getting-started\u002F4.custom-domains",{"title":388,"path":389,"stem":390},"Support","\u002Fdocs\u002Fgetting-started\u002Fsupport","docs\u002F1.getting-started\u002F5.support",{"title":392,"path":393,"stem":394,"children":395,"page":-1,"icon":397},"Developers","\u002Fdocs\u002Fdevelopers","docs\u002F2.developers\u002Findex",[396,398,401,405],{"title":392,"path":393,"stem":394,"icon":397},"solar:code-bold",{"title":250,"path":399,"stem":400},"\u002Fdocs\u002Fdevelopers\u002Fauthentication","docs\u002F2.developers\u002F1.authentication",{"title":402,"path":403,"stem":404},"API Explorer","\u002Fdocs\u002Fdevelopers\u002Fapi-explorer","docs\u002F2.developers\u002F2.api-explorer",{"title":5,"path":354,"stem":356},false,[408,353],{"title":402,"path":403,"stem":404,"children":-1},1777756871416]