From 38f7cae398e42e14fbbc92672019c7eb175cc02f Mon Sep 17 00:00:00 2001 From: Artem Navoiev Date: Wed, 2 Oct 2024 01:58:35 -0700 Subject: [PATCH] docs: add API doc for cloud (#7164) ### Describe Your Changes Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications. ### Checklist The following checks are **mandatory**: - [x] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/). Signed-off-by: Artem Navoiev (cherry picked from commit 504da7d02b7eac0119a0477502dc88409965d7cc) --- docs/victoriametrics-cloud/api-1.webp | Bin 0 -> 16500 bytes docs/victoriametrics-cloud/api.md | 50 ++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 docs/victoriametrics-cloud/api-1.webp create mode 100644 docs/victoriametrics-cloud/api.md diff --git a/docs/victoriametrics-cloud/api-1.webp b/docs/victoriametrics-cloud/api-1.webp new file mode 100644 index 0000000000000000000000000000000000000000..600d9a8cf7e91c1a791165d40ad048882c57a5d5 GIT binary patch literal 16500 zcmY*=19WG<6YsaSwY9OeZMR#yTidp6+qS*6yR~g>Z5!XWzrWslxyi|7?#ySBoJ?}h z$y_BVadB%w06<+#SV2vJQv((N0O0*CgkS)75P*=3f@IL&CJ1(s%|?02)R!NZHESUd zt$tPIoKP?@3PD0>gIxy6Z`%wE83hecTF_=R{rxzb-$4#?5OAMtwV`H1V^!vGC zChLzHLrdf@5BTWbAKjR6!S? z?tHF8EDgLndmX-fz>P3EXB7_*h;Sa4+}cHE!e01N~9XsXiX2 z3{8lMNY<4P0UBeTd9sKD{`T#7Fl!DO+TGr0ZGD(Sip#Ts68}U&%Sey4O z^!eL9Ww|8(5In0F_L7AG6>*ix4|eBGYt1YU+m2ylLm^CM5nJKtn=#kBT^C~qUSU*K zd$zsjQ0Yu3kP)S#qV4hiaTc$;Lo_7c-^BFdek%$?ghG%z>OZ<{sO(u)hP5p+l_FZ> zzwc*|df+fZ#WMho!nPJTlfH?z8e`e%N2O<`TPgFPZ-t>~-Eoa|Hy}haa42ay>$Wz_0J=bCd7XM0@ zW5i?Bn^G1qjl4dCWo)|K}2s>K+EAp0%!rYKf+ zNUVm8l^z6o9m)Eoa9rOcXdOeZ&W+Gm1WA4Bg*aro!bR?zM3!mvScoJ&MFbNQ389#w zc;jf-nQqN%BNba#Tqv~(B=bf@$lA)V!d`K~9iPj=*Ib!C&ZHAo%O_acrGmpLTLy+D z(x1`7O{3)OIcVu1gxIpxaFTUVP+{hs$zI(gh+!KdV(=7gbiGD?CB0A=5*5nGOsWJn z63H^$q=-~_E6qiMssyNdF&nhcMFm)|j;HP66aSapUk96uCb}d$Rdm&3Ay&9?2ES!& zugCPk6!E1MRrNEwUjXC#AX9MW+WC*X_D5J~w4@>r5HJsh{pL#zjMk|7rc;dja{8~g zbK$Uxi|jF$Q<+y4Q2{&3)iy>yQD}Z@rE{1hoGwVZw(CaqJ*5MpFe0?gM{`-~YC6bB zv{ArO)bftBf0VndCy!1kfWlo&4JUnrZ6&nqAv3F!E^8mAiZiTfz@GikW%t|gnknP7A8;{&CQCPIkr(ynve(NgDo}SeIU2`{R9actfaEx1AL8VLQX)28R zQ1Aj9^U8uJIf(_{M1gVwK+Wu^N&=O>inw;zBO(GRabS56B8fPi%$`$(22rQOe^APv ztcHI0t-CBV+oLkW=AvFxnX&C-H}X#RJ`1VK>NuEBgnP|}5Lytgmg`guOQ-<2SI2Xx zNa!_O7rSx3uQ>1aT*qV?G9|Bj!+Ou5d;*2n^0DVB&+NxdvD}OE z3}_d~zDa)eIRqca18>?m0LyWhTB_A|4J;U!W#l=6z0#U4c8Z8mngDSInvS4ENI(e<`$igdVIn zh+Y?;EbN6Z6sk_nReY#yxq@@f8#_f7IdUgLh|xl-dIe>yXkrYAcf+T&z*T>^YF3FL z6z7ois37gA+(zJ|6Bf&Fa*-8urd59k1xX;tSWFj&Nt>-GI{5Lk@&vgym%3j}53hts z1GY<0t$n|7lJaZJV=5nB>j~wtbo#eAqZXDfDv95lR%J7KrNd%6-cbx6Y(};#dSKV7 zR?w@nu$}Zg!c0hYXuiNFG4Y9nHu}p9zN6&n3H-!lp7z|6fH3i(HG=;~3bYplxKJc( zOTfnf07#wm>qPXHFyq!igO8>CCY*uN!4xd5e*tWCvkIEa(rMf^WGAdfG7KNr`@2l> zz)}tKTiy&9i*{Q2{bQhi2j=UqZ8vlVqRtR7zvEp4N}q&T3A8lg9R-_#Ir92lH%E=B znkD$p&2MS4(zXDD-tX=1g8_UQzU1FEn_BEK8|Y2 z9v0eS50thvN$jsm@O;loMm`cZuaZ$zAYz}V_Nvuq9@RFR6L?O|Tru36xYhKi&KP<8 z;BRaSN3+B~1zo?5LKzU~7%1PLS{Awd_W8~)6_`?a{P=~5}}LdbJwd5U9*BFda*$*+bHP9*Vms6`LIy0RHRy{hv-Cvih+bWZnzVwPx+*Mle1L+ zfn_3}cU2bs1%K5UgV=j%;-~LI6E!^e`6r?x&k2G3D~;TK=xgkJ$@NkV|MWM-(Y`Pd zq$A`(5fzVOlTAThBuJuAVpBOb$nt%avY&DX8&-A`=xack^ifxyLtWR0T_=288vI8? zLLTJVu-X!AWJoRIAN*}4eU7dk(>j}>8O-RE7KVH!I4^Rtcsz}lF2ZbY_%nvkoovzo!T?S3 zQs;nb?$NyZ{92=gGAkI*rOX|(;9|r75E;Nfls=0c%c{TeR0#{PbPKJa@oBGi{bU2JWco}f>l& zzbH%W&;4u-JVkxL@3V0)iW}+;uGt-g_^3pn(4OQ>(NE``yf7&rPrY>6DkOIqiYm{xdZn$9!qdGY1e|r}`SS;!kL-_K}zY1ZtIQ;#9 zv>Vv!ZtsH-^@Z+>(Gi>}u{*L17ZGnpwBprGB{~&LP|`yb%*!BK5;x}7bD2PS&+9Wb zi$C$jM4OT1ognQx6Xucj3&Oc#%gL!ugAxd34+H?egXCUMh@Lyzy`a)hBh;?79@zB= zs`VkmXhMy(yl_x0#E7m1GKrBWu4{q|#8oW`vSO>MwVOu}E2!SCIYshPNsQs+7ksQ9NJyN_DX6u6a=~Jkhmtv|UWO;kIxd=&q*685*dodviZv z{Y09U7<}W&6v#H-)oo_2XtV^1lN~|bxRbIaLOnr%0?GN+Nu(EU(t&;{VYV1@_kLw? z@9`~I%FdsQRxGZ9s*feCD;%VC3cKc=(->cdU6?-9Addu8UV;U3h)6)E=T6=sWHCGl z{}+yzRWOat*LXth8#V~-hf|!@vWk(% z5C+EATa{fBEdIf?PBowDtwo{@{%R-ZQ*z4P?f2R>mPg(2dOLRyr%UCldg43WiWd)8 z<3hWWT??r;b1V0t?60VJ=rxaE{vTml%Wk;uoEJ!LTttL#F64JQ6p+&9vVIDBvc`{^ z1=B{rc1dWD7RCxaD;3YSI&vKrnnIre;9RQ6-civI%ClZpVU-}VjOmFV{d};ks|(#L zWQ`JAAOCK=dzFI!S8N(q}gnupCbEK^~a_p?8<`ejVf zUp)u>mwHh24>Pbg5J4%z%sjtefW7i3CY5KwUrsUAQ5Zfkd$+c{Pb|K^cEUf+oGVGvz6!O90an$aY@ai~6!2N0 zj$Uv_cL_I%3a4mwfC0tH5oS_X0>rL(j@;8UOnLS7%4nH2b7W85;J8tpN|>|^mvSjp zPg~Vef9A?oDf7QrBb$VrY$m(}4z}*r>D6G;@SW)~-zobHS6l+fOVVDGu&BYKDxH!B z7FW(Nq;ihE&PRNRKf*U=;a-JDL^qTE^z(;@Z7VSrzapV43usLS2&MaWgekwJBRTGP z47EJ%`zrA-wFvi6Yv>V(CAl*V}uFq?tcTN|2{cOQ}K)r0%O z<*SI^-P`{5-pOlhIFp0LOX3IV)Aoh^QMzjhxCq*`@v+(_g?ZD@cgO<@WX5~jl}Jk7 zr=;)#;yHrZ_^QQ8$zJ3~I;l@p>nytRSjUHJH4kBe{iIlzDM$oXMg&PMV=txe1jQwE-!mzW#(yitW{iDtq>%kolUB|NLi2J=|H%~Wu-zoI64;uH;=Hv29c9} zc0j?W2Jn9uid(=`T`xXz;O3XZ7|1}xM0s_neAerCba%wZK>Lf9y6k*!#9eV{+h*44 zcZ+?pG1ezm6XjVnTH**;%xp%5QMd%ILx}nx7=|w)=y9SqJV23?R@@(c&xk?Pc^3EV z)YQ#G8bc!lupVQdv|R9^ERI^paH_d_!<4?nYzv_7bj+~*{b)K_6OV5B#N|qy zE##1~o8v}9HZK!g^oFBg;7H;LHZS8$$=mdzRAOb-nhmTxa2hl2X0vT{`@tXtF1#Q} zlu+$IPh(Df)#4; z@?FYa55vlga^s?{yn}^;Ht8t>THbccMjw5KUNL#2;{$_qpNE81A~zx%=(!nO4P~TyoQW^uF5P&gRyA?$i+;O_?1+ zWU5EsU7FmNEZOf;>v~ftM<0SRkQH{x)L>($Ny+jN^TElF<%w3i;!Vk^KKTwq`{XU< zF-`lIaxsld^OmTEb|wxKv<$c4O{7>FyK)kB9I7*{BkLRc28Qu3w9#i5bEC4*F~g)s z_MN_chcCed3*8^nAup_5hL#I#N#~WUY_9fd1OE{@W|iJGO@@Gt5gK_wpw=U zg^d?yKPEDk^vyy=A)9#wXmZLDZvj6iNf13vq0E7tG!IRF3M%krfyih*@0=Q+!xCn~ zoX%gXh`1|G@Ox7Cj-$nB4#UxjM}7-E%N%E+Pf0WIF-O+a|M5e*XBcBd$Cj5O%!>rn z0(9Ta<0T$J7!JdthT{-34j`xOnVuL?@;!>=x;~`cT5hO)A!*8#l6Lm~oDs&Z8)3|FOZMBaawNx%yS$}*ZI8Xb- zIZG%!7CFII+3*a&!h1eO`&dO&#gdFF*-j>$Kv>TmDwq}hb2cjRcL%dX6L&^sEQjD} zG*?ZrGE#_Gza3f4kESi`SBU7^ad+p9|Ao!95<6B6gH3l~SYv7Yiv237-r^`I(x|Af zxlka(O;WXfW$_SFS(DSJ-y&O2ToukUyI(Q@DQ)sV(q zWA!WTxw6SwE1GtWs9gpV>jPjabHJziHu7BwaQBnIj$3`pca{nq@?%abXZ$ z7^n@y0u=MNv7wv-?z!S8%=T2=3Cf13j{@dVuRHPS@S7&bG;PC3^2UdmKR%a!(SEgh zgSuKDYRqkPpUW}8MJR|Dd>}#hrQC-<-X5^|Y@O{3?(H6VBswu~(d^qs9-+EI+gsb93vz|nC~Pu3G%mD-@F9Em?5yN1!cnfr*w$|dW$(bZDH3gc&?hWC=z zXhE9<-ytVNLKaM^;+~!RhEC+o`6GD|dOdT*q&IgnRDOwWa`G=MX6q;99P|C4S_?UB zwHjMf?8Ki<>W66v716Z8B2BODw8BAb5g<^G(lBsjlJnw4oERxN=y2kNWO0;$Ut?Qs zw!y)Ri{5~lTHk2lOEg1Dd?AuWaDYm~M6zynkR0oOb-&0^Wrd&SJAH)Z?}VoxS1uj% zgS+E^FQnR1_C^VxTb^D?q|3n&g-I2y7D1%5y)0~~oFd6Z3}Sm;OwyE1x|=9s zSRB86iwR=LFBQ?DfNLRwCd~?vJlIn3wVdLd8YpMTLRD^*NQ(ciLjI5paBGjwU7jMIj_*LZT&*zPK_jhsga z%i9+1?OEP%LVPzF>KO=+sITvuPjAOdqFhJ$q4{`k1#XB+N_L`!gBKi`h@L&=pLh;M z6=FSh!9lQ^X8csH$<6sqx(jKAUzlE(sA#!G`AMz0eCxNrAImGK4EkxH6OXsd7m!wU z7*Nydj~eW=P5lu@{-@t*ojEOzH37#1(JR(la3%pupcYY#SLuDAfS|_2;GHjQAPh!3 ziHDeT%U!pgYi*fr)16lZF8`Y-ajSB_r+g>=Wep25#bV%CATy|n0^QUYxwX8xB)+CW zOx3yMOI8ahGj)Pi>(3PCErXw4d+wqvu;huY#54oa><35gIOdc;<7dc(QH|A1Z8l2O z2FdR{%PTcD; z;*9rk8<|30mi-d%3>!ZyZ-w&gv;9QB#2VrzzOHhc!((VS5u*#svBBZ(o04JL6F z11jn%iYPn1bZMF|67yegp)K1T-rc_?O2`%^%f3%D3cQupw~+@8o_swVA$>k_y7D3| zs>N7+=PgJ5A~$b7N)bSb`g~n<&_lNP?UfoBtkljJI{Zp z;5|U+HPAqKHVDIUTe?x3P=*8+fVFlhvpy@ceX+_qhlvvoN-5}AgHxme`*YR2T!Utw zi>nYf;SfHyAb`tOnq5*}4X|3MCHS0gKDKb*se;R=IO-VvitAVp?id7@*B8JC$o_p0 zg>1^GVAMED{wDc^ao`B8MgmycdOaqaqO@<=9~^4BX89ymYDhqi(+E50CqIJGWVGL^ zSA!Ry1|dIisG-bcP3TT#BZ_LQxE!sVEv&wvj2$hu7=dOq^yPInz)g47Ae2{93uWw! zUc*+hSsP)i#}fe;Rk!NcBw{4kI&#m%%Ad1rU?1k>!>dU+-~?AV`;(HFa3eq7>-k)F zgv7`{=suNcH&R?ca#4W@1hvN#dhp2Vk(;f~k6fIK|LmqxYJAEVVHBbdhHc?nD~@DQ zB+J6O7z4E##W<8BsMRYg4{Z@6=3vs7XRnGZB#A$CHC1m6SC&cTkpZBTrtcT!ChTV8 z=|4Fv7f){{izdKBHYyjk;OQSwPvOOjBmqz-MgQ1qv{90FN@nk7YnMEeW#2fuzQ5u@ zYzjQ87oH!qt^~#*KE@@(e`&VFu}=w+7~#a=f2iGM^@f1~pJF2FUQIE*XB716 znFOxaBtCj;2_XP~ZzqY)hyehFRX`31H4&Hx2!Dcb_K%VxQj&r>&(V5R7z^7wMO1W& z?+M@@h0K(3Nc1p(yP>Drlky5NojUAE?_8B9-3P4J_erQ6JF#Bn5do+Rx53s|nap0% z*U7u4H^Lq7hzo3fln`Vr)ckj{CpFiWyEB+p#_I? ze^mo`QojiQ!SQLjSA7p;efOU#z(hCvsPM-6yf|8^z5PP8 z29jC6OnXsoygCV*Zg#0be=^h^W2JI=O9%J($3JxUuCDK~`DG^TRDCF!yO!O7^`gxr zu~fJ~efUO&zamw7u1C}dc}`?@CtQ<{Onv_tY-;Q9%S;SztP$ZjBGWw&fcJIkccZkV z!bl%uN_?p>FlSba%8K>u-TBqt`Chuj?zsxTVqUdf{XIyd&Pz=9(Le@gAe}98{EM2- zo@Cz{*T!O=9C_0}`~ceP?NHGCOKAk66p>{mARDZKBmNt2`|nxeCW__2i3@B^36Y+cFX$Hx1bGVi?fD<^hZ6tKm99G_QA}G4pw7nd1=u1U-=%rLkv6(Vr z?#4|dUCf&C1(*ft1|EBflaZMsxli)R6bN9i(i0g#aaWJvb@jcNuJiH;eUw&_w^v{vHOFT(b$hPZNw##K^xSN93N6 z==gEA%_$|FBPJF20?9FqgEM}QYNoD^g&c=U$sd&jtOjntsjb>?S`Yw(1Toc-He%vx!fjSwIm&+kCiCbb{sWBXQ#y41bWt>>=Scd z+Ii)ARLd;}(e+_G7s8sth}=i%syH<4XV-&zAaXHb1Di3^CQUbR2^lYgUL7$n$2QLI znqVm$y&e`M=x@ygFR`2CJ&feeGBq<5e}sIZNV-d+Ge`bvPN51BY@feb`_q@@mcBId zfPKtF1(LdpiOS!KX*s^MX^ie#gA`r%NJE7>*nnujMERgybCerTF>uap5W}vdKx{!f zcm^p){6&@g!}wADWCJ4Ul8q{yFT^F`r_gKpH{3tkRhxT~MD{}9$l-*?Zlh4d?vufH zjn$3^*|6qK)6-fBC}MY@ci;Jwr~2KCU(q2lm9_fDlL)hVjL>4<3A0=^Y0M@-(y@j) zE=PR$+*r>OUf`z9vVS+hW4Egkx+G4OFe+k}YTL;C23zV|1>5MuqJKw2GF}mk`S-Ll zA`_-iy5}N2PIA6DmAx1Xq7@09nZ#!YGwEx>S>d7J_SRu6SlgKrLO(e-$qh+PphT*s z+4zP0n#%dDzpf_}1+qq5S^#euqu?wm0L+(y^75Gc{nNE<{PN}^EzhH0*t9^ESTSO znTn@tkjBB#zx{$d%C+`CE`oubKO6Mb3!PH_)3%8%&zNg?IWV@(=D)D;s)OAWSh;^K z)OOq2Km#Otj(9az%m-zX$>1%KjN226GaL?z~F7VO_H!q{^DhfFTarU!Ss&eD<#f<;`0tX}>;EW^OdteK$utt!m( z-=vP`Ix57dRK>U%#XnA(@OQ8STCof~*7MVDW;Yet2bM7O1k@Q`WBKAtGX}G_04DoQ z#~`ggFm`fLKph zjJ}AfnD&rkTMX=Jnd>Yw4enRj;cq#^us|1cG2iRp8}nMMp=Fn6KsIr#V@YcTH&s>v zgK$4;02@`?um+IooS*#leSbzG6@^j+eL8A76Qx;VKhvCA%P`qd2Oop!nijI&(gV(( z`eTe2=vcw91wj(dk7MlrP0oMEI9m6wO$;3X_yW=}ZGQK8lOxD#ojis><^W5Dd!wdE zHKZ=YuQp6zv#(e{y6s?E3y(;!)n5F@KDdf&nFb1Uw)+?(`FV?9ZXDKw;N)d#>`vhm zCWUdIF2ECHtZgUiGdCMdBiKb7OFiyhJI?DbF0Pl^)r0k6FKnw*(|=9`bV2?69Th1e^+ku$ zY%Wm#Tp^ni;awD!NVO}oMz@I*^7T5E%yLeq!hNZfU#g0GBNxC=7B4o`wSf>MmAY`& zjdX7%X~^z|N6wzL93$AooQH=qDIYgT>xz708`c$lgG6}BaSQehQ|dc(@JF<{L98_{ z;8*>uLw)GMH#&4C8m^|@=SGm2+zCC{C-Xcwqoee!ojMl_gqs5C>js$KdGNKIFOOu{ z#@swJq?^}8L+I+y@J7swkxkWn`ZeTFhH6|G@x?tz5zEQxR0qi6M0{U22v7bUd6pb$ zEzrG1kVu#pb9E@zkA3kLh-*|E`F)thm-!z>SR>7sc6ZsVN?ZQN18T+tu6s{BD0DnC z(}}h@sgd&jIZ9XeYtNOfsZX2@DtdyJNhuRmL7~;CQuQ+*Acr|d2117FsUvlg9EFi| z{+IB_%nYN&2=TW5938sMo$0lP7$I5SQznsO-Yp|X9-;^F_c)^O5%ZNcos=Zn z=mf-W1h9NI3Cd#Sy+Zc8@;%7&Pw)m%%nxkI{{da?(3Hk^2??+=62vr3is*qa5@G7}FQAob0 zUhWYl_?MK5V4vxm+i%7m*LGY}?Tp@|^m-A>L|BG`+v;tLPM!BiIbN6(h@JrM<7EYW z>q!vrI*4TMjY<~pjP=JO5nkYr_xjbY87`$gpa&AcHl+r}NYkF_6?x^K7RonB03Mt2 zJ|}uJV>k~Gcc>gw=cvX~GZU!ihSaR!Q*-tfr0-aiHc3ro-fzdDJETr|l+$-oU-RwInPh1c>E?Lj zS*80N6uyY>39QM0TJ8^t?sJC`Z7e+14Ft|iLAFX5O|cro8hfsEy!La{YrTn291i%$-&hs#F@DLLdQCXxyqD` zDa`2y{>gdGhfwr6sWUyM)c}yE4-=BhF`*?Pd-YglFGv@dj!zc-J|#zQmlO zy>mky1TbeCAKjI<{S?>ua_bI8>l1Sw&p1WG5yORs=UQPO{_~tHqB}P079@K!o)JFES?z_Fs~|F zwX_MoE&3kvPu8J9)a>Wt0%Zga=iKBsfL*vnW+pM5p{C8DtaUelp&SzI=o zI|eWXIScfhIE+7W8?K^tBNX(6TXA*JuVTHoo~Md5MgE%z(y9T)D=de|L|Lf{+%;wH zkR*xE64VXKCfVoF4O$XX@}==qyyALqUmt$9n(X}PI=q16K=>yXlC108#(S59NZ^03?t_$lrefB`Ujox~Wbw9Ql0swB(4 zqWz^M!e_f)b4vmDJ{iuF!ATIL6nK$`O!u7aOJh*(QZKzHBonND`pw*E`W$p&E&URZ zQ~!#U9;%)yVxHMQo)gJ~dvu<=-E=ibZ;%+_BzudcS)Jwl_;cC#qwLP7*M6ofJK-Wr zSK&#crS6?@$Bc04^YZxzyEn@R^KSsaVSnVT%No7Z_wTu2#^cj4sXW2<5^lPzv^M)| zlbhV&OUzOU*X-~erRtqaST=DG>yW`(L;Fd8CG9)?D6MVv`8-SR_0seCaF2GkR=lc* z#BoKoF>D>v=xNH%lDtsSS1=tK|2*@tYFhoHkwUo1;%Sj-{&pjRLUxNggtR}zyzVzq z4HYa9nkM4#<{r4;iZB|%byv#e6yO`wMQ4+rbQ%Zj_1W7YH0`_7nVkw z&|Yoz(CWE5J*pM*^RfPiDQgd+{oB%h|H0%2HA^3b9l;m#&tJ%v(;Mk#53tIfO$*MP zANCf6LlY*Itu42^V*(ione(0b@WA}}?-%(vV+IV<=$MY9r#ZYdSBm^HpoyeZXK?{qFEX3 z;t%dZPBHmHJi3T`s`TCp5oU7l{)fK?5ZHbe$i`eN?!DuEV^3rZH$iXGt)?o}TO>y_ z4CPZv*;bUcnvG_}k_8|=52#arQ+$Ca;kfe8z1I7_;>h!!WuH}-d#EM(E-uhsyZ07QSV%*^4R9Kfb?|S*RGRRIFnJR{f6-3LcLce?5D24o^b77~a2hy2~pH*^r zB+g0g}=!0{Xa&mZ78xz+fk(8$)Mg^a2~Yt~uj&zyI3&~av-D%y~u-X)?;_hv-=Np6Ks zzc8&n%)C)v@{X|vlmTl8!2!A7I&jN)5k0*3JH*C#{~I>fbhOkwd$pSE@!B0`6noL; zPopWn)AKn8DWHhiq8_P}(bfMU0+YOkpJtw)_ki*f?OZD~N2i0QB$R#5G#hg`&vl0a zCp(y?`OL#OEk(I(rE`$8*!gA76-N)&d4trx46)Y$%+(U=EHo3Te(^K%iO<|KU#X0j+IScq@%g?vV=}!*36fG-|+e8Wg+0(Ny zU}C=j2hN4&FW7=pE}ZKvCX>f82qhkktH2wa%2^~TOsrtw4MH8AB)a7pPJ11 zbAWQ|%rj>!qGW#vhd|6&NXS4?=M{IvthnDqZkwEu z=EXn=M=5C4vHg)N0zV6~xO<6&WKBr4qj3F+ZB+ip(vX4%2xm5>V?qkIJ^mTViNJ;7 z9d1u^nols9)_5PQZoF}O=GM|~x8){Jzyhr5Ulp#L;(1@z>Kml#lfToH3(jALSwK#1 zD7B0?srOA#8O4yy4N}-I&3fBMc-`SK7^C7p<@kgS33d+q6kD3YbTvQG-w9*kf!@K_ z+3+zmaJ*B{U2!$E9>DtsniBN*gm;Y{x*cwPqBeZ3UHH7cokbO7QNk7-zt9v>VC(_*+h?%@dtIChagxxb`{;c`&ij z0LPS5jTitCR5VrTUXmRf;{T@-L??<`&QgGxSY0szAvZsxK^jr|IKEZJYpDz0!Az<$ z9;Co~xSq=|Pc%yNF;KbTk+nR zN|m)kkl^CGu3;MUON=ul@~Gs5oTpGE8@0O34+6JGk&2_=!TNn#{Ooq;(NCErE02Ri zi32d<67AO^L3`5panbXzIvFn%M=lZQ?BNhE*xVsPl+oyv`3m??MmYk6^Sn z53Okcl&Z63r~X2>ge3vKiDjTkQhAbeVRB^GZ ztq@*}eE35}0|XyI<-40~Uj~idrVFM@8m;}GyayIkhtP7FaLpdq-Dt}0I|?)Gt{Q|J zP46%|tP;?u;$prPx8ixW))4&PYO6w;xf6qk&7xkM0lT~ffJ}uNk4Y|Jw25ziCv{M9 z6}?mmUr+Mn2e8O&0V}POJ|=gvlizp=LX(uVH}OU@{+JU*x-m^SNkLyIW_e7F{+@qP z#nL(0(fIf(LwXJaGDSy2E_U0O&c3>Am`@*KiMSj?aXXnhk#$l}UP}-9zSm5m=r=4z zcw%Tb{Ad!bXhe{ztbM1Ey@K^20+rIrbNk~C(p19f=>|DSaY8>xZW-6X5$d_O5scE? zRl$ARro2w^b#PV^p$~I)+It(mpiKA>I1eY<$BzWP3ZgrR2jye6`!V>gyO=())V_V( zY_VhfX_dCBSC}|_UbY%Qd60Smu;#>h1E(7)mqP{b8P;bFBAF0we8HZP@WKmwR~N=EFf%jpQq(?H z)XHL~0)5HV(LfXa>abiM$B?J6x+)=pVSeoC4$Tj4aklUzC$RMBk@taT!7e^rw^vHF z|SG!wc$lc+xGtR>$A&)`@E`_pN8JUqP7!m2Pd z60`X{mB=Ld*03dfc(dpw#AkYtyPR5oP4t2bA z0(1lSK!!>@uNA5I@2T+jS4Ds-d26yDxqb98CKY8aU|b-6M${V3XVCnqOW&Mlq2td3 zhs^C&f}7XhNIqddk;dUl0;2lK5YNQg=T4)H73X5b`YBVdw{GMp@Ao62`1FLz*#I$| z_VA-FNfU7ZfOwkhk8w62cXhd5#r-vejzz6XQ7t}C9P3P%T!CGRjFW&-qfx}_1{U5d zjOHx`Xle!O?lI3!%f(sW_M5gWZV?=uoWl5v7Fs2sbH6A zE0l_qmC62#J%H8~X^hKXS}tuC2E{P$2#Gk*Ywsv2*};saY#v3ISyH(&6EB`vWznm& zE*emrH9Jar5EyPv+1_bLa!{#fRL>~{HrAPzDNo6qDGN0qdoXr=m0X`Nwwry`*AuW1mR=ifW(U7M{-IXybkD371H?+he6Ssa_kb4|R_ zyqKK=H=||*K=lYgUCxSCv*sAro>>xi5%%kuh;OBFxE%1IlRc=5`+B&WM

6WjY{{lETddxZpO!_vZhxf=QbM} z^J6+?2#weLy{HS--G;{eYjDFKEMgsuIL)*|at_7*y1-`kmmLtbC9xz+$@JP8bn$E< zfC!Jg1`T`z@qzIUQ(ou02AK_)XT+U9WVYo}q}><_AE230GN@m5ZA0WJPOPh z!q&9=xF|pLJMs&m4Z5NaJ!~gv@&Z&=<`j(TbQ}VYydNQAsafOMEj1WD_ zAGozc%*ij^R8-6}*ovi@41M9qhy$MY5$82i6uf;?Kbh6UA%-EhSBq#mAn=W8UI<{Q z_4jr_)FcMu(#DGRV07cN27IcTi^o@uqva!J+HeYzP^};jq>b9TLllxPOx4b$C|2w- zk#9#HPLSKGn(y=wA}_MT37>%8lLe|;a;__r!5(ylk_Ak^sL+6A#CAjSe7D*A&e*{L z4}tAA?k;~(Crd^qvx^5JiDJ%?_m96c$cYl;=yMoeX{XFKd)H5P*L@Tiv0vee$o8yd zB>?Gn%S$+uqFcGhzL!F;T&E6oQ4E4qi{iAhm7v1P30BL->(vl}4+>3!6jPa>$Qc3v zCD$+yf6Peyom%V5vJtw!9U$Y*B3Cb`%E$n+eI#00 z*rWUQ=P-`s^@Cm`wK*6Xu_O6;-8oB#2Z916nx`J(=WKr?*%%q8QUiQAcPWe9VC7f; zA@cs})SgZw#94ohs(Gnl8G+sRw;wZOelHyNz;`dPI60qohKV86Tcni)<{esN8+&;n zm_!lUZ_>unJ%eI0#?(W66dj4NsOv6l@~GuE$}p3FKKOs~@T_J5bq?*+^Uv1J_ay34 z6Fiu4tAhIm#06Qd4}dSAdl5v==jcOQ;#6lymHCR5#|3%CP{jW3_Q9jszX%LTp)HGxjh(!MC@w#)n+t}NfI2#bT+gRH= zal7-87#Q0bnsEQ6|6wzb5dBNU*@}<@v@{gharGNL+*~0YyTC#Pb|5vB!jqGd~{&~Z|M9;|Z zKkUD%y#H{y}~U8U8W;|8(ZxBmEcm?@;++c^UpUZTzr+ F{{!h2eO>?n literal 0 HcmV?d00001 diff --git a/docs/victoriametrics-cloud/api.md b/docs/victoriametrics-cloud/api.md new file mode 100644 index 0000000000..aa7a9d7b0a --- /dev/null +++ b/docs/victoriametrics-cloud/api.md @@ -0,0 +1,50 @@ +--- +weight: 8 +title: VictoriaMetrics Cloud API Documentation +menu: + docs: + parent: "cloud" + weight: 8 + name: API +--- +VictoriaMetrics Cloud provides programmatic access for managing cloud resources and is useful for automation with tools like Terraform, OpenTofu, Infrastructure as a Code, GitOps framework, etc. + +## Key Concepts + +* **API Keys**: Used to manage VictoriaMetrics Cloud resources via API. + +**Note: Access Tokens** are used for reading and writing data to deployments. They are separate from API Keys and should not be confused. API Keys are specifically for managing resources via the API, while Access Tokens handle data access for deployments. + +## API Swagger/OpenAPI Reference: [https://cloud.victoriametrics.com/api-docs](https://cloud.victoriametrics.com/api-docs) + +## API Key Properties: + +* **Name**: Human-readable, for team context. +* **Lifetime**: Key expiration date (no expiration is an option). +* **Permissions**: Read-only or Read/Write access. +* **Deployment Access**: Limit access to single, multiple, or all deployments. ***Note**: selecting all deployments in the list and the “All” option are not the same thing, the “All" option will also apply to future deployments that are created.* +* **Key ID**: Programmatically generated identifier. It's sensitive data used for Authentication. Any operation with API keys (including viewing Key ID), will be recorded in the Audit Log. + +![Create API Key](api-1.webp) + +## Authentication: + +* **API Key Creation**: Required for using the VictoriaMetrics Cloud API. You need to issue the key manually [here](https://cloud.victoriametrics.com/api_keys) or check this [Guide here](https://docs.victoriametrics.com). +* **HTTP Header**: + * **Header Name**: `X-VM-Cloud-Access` + * **Header Value**: `` + +## Alerting & Recording Rules API: + +* **List Files**: [API reference](https://cloud.victoriametrics.com/api-docs) +* **View File**: [API reference](https://cloud.victoriametrics.com/api-docs) +* **Upload File**: [API reference](https://cloud.victoriametrics.com/api-docs) +* **Delete File**: [API reference](https://cloud.victoriametrics.com/api-docs) + +For detailed setup instructions, check the [VictoriaMetrics Cloud - AlertManager Setup Guide](https://docs.victoriametrics.com/victoriametrics-cloud/alertmanager-setup-for-deployment/). + +## Future API Features: + +* **Deployments**: Create, Delete, Update, List, Get. +* **Access Token**: Create, Delete, List, Get/Reveal. +* **AlertManager**: Get Config, Upsert Config. \ No newline at end of file