From 6434a5807dbe5689f83163e988735ab351d12e0c Mon Sep 17 00:00:00 2001 From: sra Date: Thu, 29 Jan 2026 19:37:43 +0530 Subject: [PATCH 1/9] Deprecating MT Interconnect APIs and adding 5G Monitoring --- docusaurus.config.ts | 11 +- ...networks-multitenant_interconnect.yaml.swp | Bin 86016 -> 0 bytes .../Manage/SP-Interconnect-Manage.yaml | 1937 +++++++++++++++++ .../Monitor/SP-Interconnect-Monitor.yaml | 466 ++++ ...altonetworks-multitenant_interconnect.yaml | 1930 ---------------- .../introduction.md} | 6 +- .../Monitor/monitor-introduction.md | 21 + products/sase/sidebars.ts | 5 +- 8 files changed, 2438 insertions(+), 1938 deletions(-) delete mode 100644 openapi-specs/sase/mt-interconnect/.paloaltonetworks-multitenant_interconnect.yaml.swp create mode 100644 openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml create mode 100644 openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml delete mode 100644 openapi-specs/sase/mt-interconnect/paloaltonetworks-multitenant_interconnect.yaml rename products/sase/api/mt-interconnect/{mt-interconnect.md => Manage/introduction.md} (88%) create mode 100644 products/sase/api/mt-interconnect/Monitor/monitor-introduction.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts index c02c02766..222239cf1 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -921,9 +921,14 @@ const config = { outputDir: "products/sase/api/mt-notifications", sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "info" }, }, - mtinterconnect: { - specPath: "openapi-specs/sase/mt-interconnect", - outputDir: "products/sase/api/mt-interconnect", + ManageInterconnect: { + specPath: "openapi-specs/sase/mt-interconnect/Manage", + outputDir: "products/sase/api/mt-interconnect/Manage", + sidebarOptions: { groupPathsBy: "tag" }, + }, + MonitorInterconnect: { + specPath: "openapi-specs/sase/mt-interconnect/Monitor", + outputDir: "products/sase/api/mt-interconnect/Monitor", sidebarOptions: { groupPathsBy: "tag" }, }, manageservices: { diff --git a/openapi-specs/sase/mt-interconnect/.paloaltonetworks-multitenant_interconnect.yaml.swp b/openapi-specs/sase/mt-interconnect/.paloaltonetworks-multitenant_interconnect.yaml.swp deleted file mode 100644 index e69c7433d24f510c236dd7ca6afb6161afc8f027..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 86016 zcmeI534CK!z4(K>EFvH-xLpc5AWfU5X}XAFXQn_Ov()JfC{%`<rw{Kt zeC_J&+W0G9t^@3zEH%nzuDf7u?J89B^{yGS(p76#x~nr*#hfW6>oZoq-d#8AR`+xx zS*kRwTE1GTSoucxj9IRlk$6(VOnEoB9DA`y2c0z3JhU1IuY$&Vl6|Sk8gv99YhQ>D#`*#if{<_fbyQ$xG{O%3? zzPtLprrrxGLv;9i=ZrU+8yKH}*^a{&hXGLci~=elM!`n?t|vqrTs)-e0H+M2D}kBcapz?$Gb*w&l0w99YhQ1`Ts8nocF-@;mhzbxB$+Ali&nc z3qx=a>@{)9YzCww2SfseyG;2dbe zYDmFTApyTdzW*V72`+^hroVtD|O;)@M(B2oC9Up1X5o{zV8b)Jw#u_r} zjasQP>3&_G8TEN|tTU(Qzr`?SOgvF)l_6td+zqH^O_r*axz96eHFMUzN@8MFUe0?(`LPUJP@7Xe1kCSD}1-(T{2zwo-$+Arb|Sopf2@(iAisC zqgbs?n~foZU$PnZ`)R8%_vTPND+MlTRRu;0lh*K7veC?y z%B9AvSNc}ymw6wWFISs|4b>)g}sUSjeYn8_<%}QZgsnD46GB>Bc()lz~!vn0=C|N2Es~o2<8stc&QFCiW>(q~kQe6)1h4JU4Ha608W z=gGF{0mK*CQpLSpF0WSX2k4LtI|{xlqB2gZoJof?e@qSPt0V2?+2GE(U%8jn z%wn;W_pVW&-O`r|*y$!(A~ifVN`0s^n%1o@-!FkI9&;M>tWyw%gwkaMzpNYEO69VV zvk0xxtW_+s*e*pkOkJ8f`{d~{&CE@Iy*b@!m|G{^K;)*pS+SqftWZ(Pvr=1V_c^ce z(DB43WxZWZWNzS8l!`@68&xmBh?>`Bcz3xmDK;zi9An<(nB|h`w%oXSr88597E!m7 zhOVS44mInfW~ml6g2we{bGpAd{aLc*9BU)h)#<0a-rq1<-{WsN{=3Y|?E0cku0dlg z>)}GmIJRm8>g8~Gn>kxI>Q+OFaCqJ7gncXj>8#QZh|6~;HTtT^T=#X_Q90hMlul|| zqxR&|Xw-atwoXG_Y0T*&LZ#t&L%UT+k`~!sWV+tQbYThe!Qd3kiNxGgwVF1BrU3qm z5K6W35SJFJi$zl2Uf?ow@=f}^uVs;W}F-fB|GghsZM+*sw5|uW#1&H=;L zB@G#)V}=Mh##+ayfIdqUQ;B3yMcRRuWNQfx0ADvy^NTjpR@dm;n{{&%&D2DtBM}Z+ zf)kN#LNo=A03DMWqQ3?_EY_(Z4)DmSa>`kM$tLtY-c)3|r zVWs-CX$y|GPqGXnQEKJPF z;bA+nc3GeyHI00=T*m5yG%i|SFC9eI)(9(IoD)r3lO_=rmC2Cd$^7ARbqc~(!#WC1 z6eqUkQp`k#W#*@Nu)R>62a{z|oOaPUYEY#Db@aG809QjQWiwnTlqAw-xjfq`Sz~90 zGFhqHb&fijAqC<+6I&3cfWYvUBzuj_@ErCOO5&QOv6F$*Ue;>eBsul@IbkKF%Rcr9#$mCytCBL9m% z;0CxFL@)3zI1?&xJgkL%;BIsSH^O^B?E5c<=fffJR1mxV-_RM{3g3fI!^Q9>I1?(c zAN(J7`%l5U;9PhPlO_w%6_zK)IkBzQV}iHw?p4`LfX3J!#Q;8E~zY~eqE>)=#41!f=v z9q=9U*Un?2B~{XSO-TEyp@(F@gA%q18cqeZwB7R14c2Bcd)H_Z*mpYZnjlJdTU{>g z@`!46vTUuW8s87&MMlU5@s8#mZy%VfGM71*>Psm%!WgiiSioehDwu2@6UAy!ms zu@l+78hwL%JHJ$EZqjkt7w8|1(bbOLo_L5(ted!W+i~e8F5O~ubvKaE_mB`&Yg4?D z64`ZP$ms1#u@Q!0Y^6*{7!CtHT`AExvcZIy>ehN&O&FuTFlESbl12wY+?@iPHrbxS zkY1m#NCn-gMRz-G&Wg=|eyf1{fn4HP#Y#0gW~m5`(pHj=pMqHtdxY1CaordhAkSbZ zTBkO^=rV?lGTA1<$f)BBSoN{RYLn5*Y)n)pD#uMV8Z-5w?(S{dwz2I-a4(H6o@#qY zPz$@gaJr@%)8&^PwAecj=DFk{-Ed{%FtRHjphI&I~rs5JFydz6sLh_PwInl5A9qP|T@ zgw%Xve0Y4s4*CeX0W{n-yjfzhPWET%rdctr$yEpIXUQ0BiOsNN4{=m%J>79T2C2J} z7K?aD3$Z5?cDt@lGol)HEX*d~&_wcf>UHS+Y8n{alH*K(c#`}XoGX>9&K)voa%N>R z`zkT&T9ta!o<$YQ*2yKup+kq8uhPFb<1jO(viem9es|tOAeaWHWv*qnQc0tM5!IgQ z&EQ8QlPIQZI!Nh~t1`8cPL;}FiY>EZ6-)9UXCRg-f>oht^3>kCl_z=)W*1cq_|v6R z_)cY=4zgU@Lhrt6tkW1iX55MG@F`8IoJ?|bHtT-O9saixsHB7p$EhIDLFs@c^Fu#% zhUTD-k=UJ9)vU4%OVYxcxiUFn_o{jxSaWk>ea);)QtyX1K6j%NW4mHYgbSD&>D0)B zUGAksY^cTT9G%)ZD#x(D>NFfmGQwn6aX|t!~fM=oDpGB!MfH-$b3B zk*r*~(QP8S*9-*YReiM^QAD@6Ze(P2lGb#vU6o~?Wl2N>!&gUKyRBJNoI2H9CcmmN zn2x_u*)COSn!4k2($Cm{SC>(5&dgM6jTc3A)jXcbWW&re=1C8ttwD~NO}cBYke6-w zVf@NjZ0O|pR;{%Elsj~N92a*u&ypHp(UhR#OnA=sbBtFZ6P?d-W4ctqN2=4H#B0)q z3k-{S1}d^BqqqwCkHNPFH~k-nY5Fhhn~hHqvWDxjp!6#78*RlMbP zv370xH#^^3n6^XxjLec{zTuYGiFL}*Nr;XoM*EO6ongO1(t(p)!xw-`r(E3HKVy|E zXglrCAAfpfzmJCV6rJzkh;6_aZq*wrtA*LkUZDEwh>j>Jv!VN?l=MKdvzC#Le{2bf z{J$?U={J@9Kgr+n5`X`9!ONinN5cq+KfnR-X!tEM{uS^}I17%20eCX}8QK1N_!yiC zFM~8Z4t{`4|7JK52H>%9EAsq@;4D}PPlZ1rzuyQ~z+2(PkcI<5WcxoL!`}v9f=|K4 zZ~?p+o&>wVACT>T0AGf)VJl3+M##dm;6KRxKZon!JTT#z@E_#=-@}jLYWN_?y7`yD z3*gCc7kYuK;k9rC90>cuBj7G{1>c5uz*$g)!(b1%8=b+2zyk5P&w}hp@M!og`hriw zh46AX23Ei>Am#K8DXZ|yZrpSJ6Mt;uaAp!BHdRHJ=+2GA%dU`1%(=z>LM9L5`GR+l z(U%gLIO=89YSr3C+r@u$-Num(>xS2C9@(&A{f1W8uc{W9iV$cj9eJ4@sBZlJr`q14 zbALc%=PC${qLb7@lc{@^6w*nc$}=LvRK9|)Lc@8MIWxmF*A_;)rC0PnP-a_9;=Hd` zkc<`H$51y-Usfb6&-2}%8W~6E^h9}*=}q@#2dq>w)n}!XnVe}R2l@v4l2##`%Vmm# z1391LyFU!Wu*+9Baz`&BDpd3&h&P2%S2+*&fA9rowYwI}lNiz-&P5S=Pqs!#_?Nd4w4l2~9Bhoo@(lx&NJ zJKnVIF_G!>m8#W~D;E1KE7_arA4q13{h4GgZ|0MQLa`^4?N3?7KJD)((e}R_JBO~i zwtIhE^TUPG7|5rKscbHt?6vxPl9_?t-sE6DpGo%T(*q_QL^j(SUCbDR%y7eyc(iI` zZefIP+#dO!_H~%rdpy(ww|3doo!y8m2=Pxjm6#hyZhU7R>dIBA$`n+m+Erso7d?aC zXdw#jfOy)WbxV%w&M@5^784+|VN7b$lbOmtUTb{ip*l9KXHorJ!l_3MbJEQ>oZZnR z&kh;3V4!Q2mIS!f5%!JaUZ!r=GQSR8f(%4Cs&8A7@s-`2JKAhB1vA&1w#-b@>>Z%Z z3=CwG3~~H5*i+~?b3G|56E`PG8Y}v;{R6==mv}fYe(p*4X5xO1@QK!U%Db5DWU@29 zarlVQbw?!pzj=QLn{84)##||_wzsFJH`hytP#j2+!gS6|n#Fu7nKcJ9y}bkZLbj(E zbGsLzv5|GF<0Ir;CnnPkBf}dn%0fnByz`#M2#hOg+%Z=?~{|K1k8MA(n`k1MY1$ipqK462W6_%m&~Mc{YjKs z{mFrW0p?ICv)C6qRbt!-ujMl~jI7?YZuRiGjj^%wt#dPavVDEg-K>bp-eNYj6m4xx zpmaU5lR3J6w*h;(q5o=B8)n&Ci)N(O=4Nz**4KFN_SHiMTRVH-1^=Rci|YWB&DcvY zH%K=`y^X!ZnO+YW(KB~>BFae2S41T;jHIiqu2w|6h{=Ejj#^^G5R;+q_>_@Gs$wbM zESo5)>XY>1p(x!i!nt9knd%^ z|2fbEk^lb-2H}x#FEai`@M<^|o(E5Z1l)s+e+yg#m&3*I29WjrF9o(CPdpp$M()1^ zUI|Uu0IMJcd&57_0elZW1Mh?ejKTr%7v%p>z#HI9n1=Px4|~Gjko|9kE8vxIJRAad zBk#*v{!hV0a27P70LQ_;@Lgp8tKdy=KD-JVa2%|L42XVUclb9tfM3D4;R<*oY=f6U z7M=uuLKpBoxC}&3@G_A7{q}^PqYJnkW9m$KamuA{6|~9oyrFe|Kz;9+xFNJ+{XOqQ~~QE4+!# z_8r^ZaUE&t0UgEz=BK&xrU;StvRbU?zSW$;e#Kn^=#1;)f|T%zbA@(`3YlqEV1N+E zOK*-ds+X*8C(kU`N2{cD7J)Itm0@uOK~xMl(Yoc+tcw_nFBV=1j^`y;>sd~F66|X6 zsr8bnvSu+Nthf*0z&av2YF`d}dF|8W^!Az=GhfUl3%#gwkVUQJU^Z_h^XP$6)#7ao zaPeXbJ=m~cJE9;fJkj=>+duM=!9vWW;%bMT-;RZ3-TIB24_}YC855v=sb?IC4sogF z=O#&x_Ki&nI1 z)s`|1rMD_Jaricz>h9UdB8nGr=5`&VSh$Yx=^Lcx8Eu^YuPsgK z+yO_VT2D9X4I&}kWQWRY?^0A*w*HhQ2#h^i+bScK__d6#Hn!nn=s5GsItklxO9GXl zMoOwJcj4|+^*A?LI9-=-dxP34`>F2Ot!mYd9@N@0D~kNzfe864CI6R|{QpN}{M$kH z{<{=T0TT{~XTx8R^S=x4h2vldL9I|EF*{TmUbJO^}59kn_I`7eWb!;E8ZIa{gD~bP&0JJ#@k|;qS=z z_rMR~3b+(x4Zv$*4A#R4{1MsyC-7;w0xpHO!^>e3j)50J5@esh1pEeB|8lqpWc|R) z;RHAmo&k@9dyx6R3>Uyg5MP1cA@g4iZvYDpg?}LP-vXb2b6_=yZ@}%y`f|3x86f-c zb%K=LJz?2jm817YCm-=bcChu{;xcuRl8?KU61;mDr>dhzx(^>7T{E)!;6%jjd?g{E z@RQ+<`!=A2j=8XXy|YpxuS30#2jsk3XLY%=4_+HOXJ%VZoIX|d#4||Tx3wCdE6SpEH9SZBI$p_HYYx_@;I z>+K1sE0u52cIZIcR@L?NXLCJy+*}6-Quws>^bRC*{rGeA7Wxahf!6&A#o4nNLl}{&(He_GX6W^G?)gl z{XZXMum4@)PssVQ{{I7TF34X0;`_fh{0v$Dy>J>#!?AEE90;=B|2DV=-U(Y^1Y`}s zwaE1Eg*U)ya2%|MLqXR1{{$|A7r-H~3&=VES>yjR_!h`IfJ@*!I2BHSQILK7J76z( z1pFQu{|2}cE`T#Y_e~yq`j}+R9~{cP(&Ch6w=9Dy5CCn=dxBYogL`y$;4?s zY!j)ML~mHzKjD9v_xFw-u%o4>McUS)61L;UYcG=m)65+vgYF3HnwMh{<^PbjujSnd z`a`u-UYr5Y*B9fI?q-tPF9+(nXaDoAjL;{!^3+o7e14It`&93F0TbXVH^QnuM|Sl} z3pVHC?bg+MU4yf~xLRFU$fOH7v&T%PdyBGmsAnKKz`BHFx?m0#d;5^Ua&apz{HsS< zIx05SRdT$I;hb+Hx(0SB**~HcOI-ZD_>OXONk`i;7TT4EG}~$wsgt}N(U-S$c8TiC zB|r7cHz+T)Y+bqEl{EKH=*I-#{e}79m7#;>*y+jBZu)jaX+AK1FN3)rG@ON=WNNU7 zRl{Z;?J#SKlDVE@zNe7QvSKhFQ98mK3pxKL_%^&5 zUJ6ITAUqcy2Y*1`zX3i6?}5#580-)KM6SOHE`^ifSjd3L``07ae+15f6JQYbhMSP( zFNd??NH_>~g`XkIe+J}yzC6f!|9#;JNTGWuR!ZENK4uq$| z;_V1*ZJ)J!4|7OiTK{1 z#WI=A_9RUfld}>n#pJy|#WHiNknbJr&6vH#=*jy6X8?{dbBi?l>KAf*1AFqp@ujuu|1N#6RbX&C@>lFjB6EZ zo6dMqT-5Pya(3NPJGllo-(u$;wB7a-gEluOe^gW=Co-yZ-Mw_xwTqd@L=AP@#VK$g zo64qpF!|*3xeU^3I-MNIr&7s+l`=DfMXQkNjWhl@YsFYhO23-w9n1`7gZ0F4UpvUi zW;JEwp5!*>Z*lgmq_Js?eHcbIkB)5~TfcsdDgrlV>JN8^r1>rz9v>e)V%N90? z)^QvfpXcJFk?HEocJ&XiLufj>`x8Y@zEr4%doump(#%TsA>86xTlDwNJNh>IUbC;S z(BD5em>eAJFC;VhTrb`t*@0wl&p@$fFg2JP$i#UdExanS3V8KP6TxWcPs-XmzG>yU zk&VZ!-*D7sRf$%OuHL}H;k9G3n^w%tKIbi|m~k;~vtll+DzQ&$HQp;{G4+V0&yosU zhT~dTs4i_9H^x~$IVE?+
ro=g`z#!7vPtM;wyQ@FnCc(xzQW0o30l?;0;+{GrN zon|qZ&kmTF=97IrGJO?&B29tmYhPb~YJiW$m~Dp^I3=;SM9@Q4xE*gFKcyD-@W3V# z47jb#%fVSdV3fD5$l7$w#&5FP*>-JqcE9)SD$g?{k*$o!>Nz?u+ErD1iVJNew(TR@ z+jB9)|BlsI_vcgD>_A^8nI5$8)stNVa((!2rux#o*>rZWx352L4)74wScj|__nVPf zk3b?rW?M| zbDk|X?qApE9{c>ieGt!Y49Wj;{@*nqJ^)1+hNr?Gknz6>7sIJA4&wL!C=h@Dx4|}; zf)U8V6G7zv-y-A7KL6Lk74T{}4Gw_ok?k*o6X6&*9G(YHhFg&BzX4am2jLu;fwho< z{Xo|Ge*xYNTVW;a0l!4X{}Q|f%FqdqfSZx=-vUi2!YYt;{Z9bd_wU#69ry}-5?%?X z!eQ`2$iSbG`|pGsL45izhI8R)cmW&$_aXCt2i^%4cp*Fm{*0V|HM|}sLH7Q86#NCb z{tmbXwEW-X?-FF84-SE!Q(jVL-}lM?N_FG3wk0prQNu*C#0JDwcH?rVJu9?y8W^Hh zC{v~<{s&g&*mt+5iB}KqK2@J`>052nwsflY1lPW)iyEEU+yyMtH<-&Yxa7^Aes=FG zqKE72Gn2*s-c+C2Zw(atsdSOmxGwQu5$MI zF=A(jNqch~_YpA>3B@-~2w3PWc5ZxQ<0)AZof+{{`MJTjp31kA7Ym$(%D}7Upt@pq zOEL_kM|-QuITGZ9ab}uy%HORVF&#lfV(mSkg9&c?ybj$RsLH3Fo+Llzup#v^Qc>lc zf~zy$y>a2574|U>vXAIUU@`f^eJi$$ZYyi$dipY`5&BFv6U$_J@M#{f*ikJtm@f9^ z_%{$YuU)u8VRYT*u?_2w*f26a?v}d|c(qn5%zwYHQ>lxH9VhF~(HVH#*#+Xm2S)>? z2e3xGNW3T|)HIu_=Bs+|v_$yf`g5QUUTfc@`{CGol193xt8YM*2;J$pg=MW(2(4vr zR+QYI<^cN)vK?*_Xd!>=!f15}_?*MCgZkbF-Y$@I4oP!s&4hhkg0oSEH{J5DmzI^( zIg4HQhF&qOz_kOEuTaIbs+VH~>nH3HOzcd*YecOP#|GoYN>ml3T}ck)4(8 zF!Y|5uGPm4!wp`a&msr8h}Oczt(<3k$?i*6^np59{q5kUD|sG(P7;9};253Uh_ zp1$829LyxGL3?Qn3xfvoed#1dkK&-2P372Y(ycAJ2{`Wy9|5-i5~7yfe485N2hz0h z01qtNb&wGIKccK7N8kb{s+DYXMvmxuoZe?e-J&v-_Zr!3Ezh=z=uKB37i9RUV!Wo*bTBb zfcOi15#9}FfcOh!;fZiNI)TgJ^)Ll1;o0zabOJZR2SM}%a#lbWJO+M(Uf^?ZDjWkz zxCec}x8MtK0h|M(Gmy0aYv2VSdV^g+_5k=BnfWPrADj%b7vL5+7FIzg$X)=C2H6+z z4)_{e4yQl~j)f!OVAu=(h`!)ekcOY2BRCgQa2t96Icre-0YndQgRKh)ws+^#kTKEW zTcAJD(K%7^uAAskJ#vR!r`r2OhrUFQ0NxGq*AUaMP$#51jY2Ast?gY zhAM)dgGL5_YWR6kK{{T*Mu&SbX=E#N3DEt@iDRkYq_`aym#A#sBnRf&XWWW7sV5gY zA9lDHt{>EDg6hn3c9KQxT4|TiDGO~NBww%48pOC=?zFC?-A(Rhn(bKD+E!(%I^oT& z=c+P!qOL3Ls3LTN#N@IRi`fn{nV5y5nKIM;$)eTI#@c-rme^tze}#dG6Ll*?WUx^aZw{o}+CmCo@}h|`G7^-*Z4H*Lo~p*`zA=MFM>j8-<)?d`KdiBKQ6 z-{V>Dzd8A{d?fWdL3J z8phD5HD{&dJl3?ywmdu99)DD>irvlcYcW$R>61e2o$l1$sospmff%7G<5VEq!lHHe9D{0~$m8tN=$H{b zgQQpES}z{+4Z;tVin_QRf^4hGpH;3_D?OW{b6y#b#L za#r9iApQdHhF8GRa0u)He0 z9Aqzmm9PT-iA;Yzd=f5zCdm5#6zmDVL(abeE{0i_sf|8?}Z8+3;V(2 z;UAQzl<6;Qoq(@}g$hSD4!MVsV|8;Q`P%j$*n7Tg6Y>6*oS1ZHIX@+ z&|mrAISL9jMuV*IP9ToF(5jfZvNa-yz}cE<9y`R|%;kF2aYR!b0a%@^nbUfl@IO-i zPU@Lv+(gs9z~YRNxC`uL&#__a=XlAA%~y$p<11OkAH3w9l%m6M-jhb0-&VUZm?vZX zu~3I6&p9qxN2%5a!^!J zJ~*3_-qL2X&x6QIpFhs-m7?)Wc-QE^R5ju>o2b<5GwoQov2(S(xcI6B#U$44is&rd zjEl_T<)&pmNFvi)?_!BPf8QL$Q^HnA3WX&r6A z<*!4n;Hk60+4M}!Vw3GUhkrTGSBJ{iM7fH`x*FRZM<9EccYaOD5+nQIFOOjp%WPfCqC#cjoWif|o{r!`)hCL*dovCB(4%KDV^fwsOv zHyG2HWOhCyZQ7a5)!X*uQx6ZcW9Q+zZnUGp2pVkM0^2FQ`o!MajysBn8^Q6L+1aAlK=T=zwSiV7u&zs{a*tX zya1jEcO%<>9^M8O5L^FKLH7Lr8e9fvz|n9pJPLkL+ga2!d@16sB&)57vP?r_PfPSq#v^PTD$*P? z&57@FD7@cSJ}3^$49TqJr%DaBL*abnPK0F!KV?WmYR#AGmf`G(WFYLClh!m^Vp~u} z8_o7BI7_qMS}oLZC1FYDgmKWu@gtaQo;xEt8P|Gh%AWO1rorc zt(p#a9-%>m@K!6+qof9{qEAv(KE2a~VO6%4YSoHlVwXM!(#b4a?;x>enTN;^rar^k zKCpYDVww3ViM?1ko2<48W}0b4Wm!N-@e~ryT6qd%n$ez8m)O+hnUYVoPQq+(Dp-jJ z+S-y5If!z;?rdI+W?=sr?x){(GtGxT35p3xJ^ z2Rxp!Iv8D5T3ZaHXPuiVOU-Ep|B3%btIK1X=eld;RYNyMUbQcRri~Q}ALKhJ)eB@MsXMd(u~}hF z9Y$EDXVZ~ac)|I4t#+?mr1?|I{$XexZ&~W|6}CJ4Eupmime`%P@;GBntla)!^;>y3 z*Y{xewqDM<-#Dj#i<$;(AL%}abE@U*@x#lco!MNOURPq}_I-1$V6H45_FtMXsFkIH ze_eA}KwjNMmZK-O1xQDn69G?Ku-W9)mssbdS_4rJLt?#DuxeIe#|g-x9tF8rq}x^^ zZ9sDNne#=r(qv>B>WQD{zq^vTn6ugS3w0PU<5=5@Jx`i z0RE1=e;bHjzzSVX99>W;0;iNRj?n3fB%m`d;{JDQ*apU4R;~)UjpYr z4aT4kb_dx5@LISCUI9l#C)`IlNm>1mtpjk%ivPWOEq}F?iCVNGxz}%TZ9|-Spd{U8 zEyswhs4#+JfYx#>ppe^ZnhD%Cabm5DcHPSdD`*JU8IY> z6VL5!#15!Mc1l4%I0Ck^A-kj6juMmHF0$oZKr3v59skafjOf^hCM^pQ=m!U)wZ;!b zhWISjO1ZXVKL<}Up+mesOz$yryjwwI#_(|AMh)FNl^DO%8H2R{{|zDe{~l!h?}6+C z@FtKm0G5^9X)|-zbd!XO9kukgJly4 zUkwUYny5~EDcTOF3Df6{;%3>dW4PB-`HydxU1hy>r4z1Q+Pm6s+Yd;-9qVP)x;|pm z_T$FwJ#SmPMHKd}O;?`!xC-P-jal2TeBoAZFG_Xak?-S@0G-`SwRbzyaZfl;IE{T- z1|}c8Q7YcMcRmp#QU-3ly6nLzD@7)xO~w9_1j=Q}*lCjd9~jfvSz+-`>GM_F7|A$R zyG@;Sl*ewzbZ?=ZD2CL*#!% zlb;VO`G|7Jn&0q|V@-VMa&e+9e^ zP6OG~?+}o)|9*>{e?7bpPKKAl5Ih6!MYg{IE(JLUa03iO8lDZZpZ`6`_@4*a%YO!r z1d;t81NS21{{Up~{`bN8Aba~A4;!El?nT!BEy%up;{X3It0hfwir^4Ws-McnOG=os(6hR^uS2V?Q{w8I>%g-6p@YvlK3_HOnj~WmSfumYB*< zJV(3b24#XV=fL=QsleN8iVdmkSn!{0Dara=9q2-=VO|S~-g0V{tDtFbMduofbd~%p z%Zxca327$b)RCQ11SmUcX=VTN#B4UC9_Y{ZWuk^uHoJDS(e8+bd|yNB_37obs!~qH($&lB^Hr(MbJfFb*O(QyH(4;_y&PP` zcp5oB4JwwF6{KDc8$K(=yp8ukH=>5y6#Grc9tSgwYkFJ7=wUTHc-oE}Y8wJh=3`-p znXgsr?DXIc%3fC~`&ii90LwTRHIB|RhU%R!qBcmdM`U(cH)jzxnFo{@wa~$pDoazW z=^;b)K1pAxw>N%zous{%hkcEA@O)5KA=1vtT|>t3 zs*R&Zk3@!`=0I((e^AR`T`N|r0p6>PZ4KN$EuZ5Nqowpkjq>eSQkL`A-ZG&@{)+tH zfy^)G$BF-cQOW;5M%Molyb&hhND%-3-QYIl{V%|4p#%f4JNyh8UvvN>|DOiaa4d)p z;6RYG{eB8pf}H0k{{Ox37!cdP>;WkI|9ucd4^V^6AZPkL5B7lXBlCX)#1CM9CI7z> zS^sp9J^jaE2%Z4>%p&*hITMMa8 zi(J1_RWYk5y!!BL<1aJY$aO8>nQAw0EXQ5Mr+%d+cMx6XTAz+ma`? zsbfxB9TTfW$Zma1V6)C%PI}_M@WEy@v|e%N_gr)b0__>r)=n?+lG{SeCkq}bd^gC3 zFQr0@PE1#M{jQ2m>t+Hfc3mO#wNcZ_2h`mtenCeTv+kDfm`zYgD*ltpUs9ZkVbx2u7d@TfX38M+9OG$sp|g;KkMM(UK> z??$3Jkq1`G8)}0S#*EoO=~$_E`gi`95wg=3S0l8(;W>h<(v@p#)h*r;13pPq2H`3v z7SOlY;hGg!v8>iB%ri%bK1!feiPGr0>gJ`%r7B{2WLWxC!4;kocICn{xfAZx=Z+3; zYTER&Z)d{b3p3t5-RlS26fb=@EOpKhXU}=~s*VGht17lrz4iYQGYhwzBX01|26j&O z+K0gWLgatM{>1y0{J&Yrl%GS+m;L`PfLDR&0Mkbylw&Ib4>^8Zj_LEIb9oFW_dl5}F`q z0~`*$us1vg?nMXiJNOEG0VZKD`5W1P5;nn$Ky3dP!Ya5Mx&AizA2qXPau#IgxoNXzyE}@=tTkyXFyXQj6cY3t7fDA` z=x)h7Tqu;pwVX?5JB`_DlO==|V{6IUrnbPdhi^3q_|&bQ1EYNbayjqL`0FUXl^7ls zif4P4Q0OkyF3gUO6aBJ%-jKvf<{mmw$C4a~ju%j;6J>Y5--wGP;f|`fb0QJmK}so} zZM{R-;_c*^?NLg8>MX8z88212#l#`MMWX4bGdI{rvl+uaP7uO6^w{R@aPKuA1cr8wNMFRcl-7T?h~f`_`K48ibzYZDW&6$~MO}boF5fk?Bi<{Fsrx>dcoN)C2?x{ROMk<>t^!DYmNh_1d zCNoyrOb%vED`{qPslIHgKQ)laMTX%X*(W(irZYdq$+#lrZcxNKwc60i!C@s}? zRdolP6PX#dI#VLpo5}>&9**oW-kIhw4!YABXYS-AB6O`)o~B7C^>CkUPab9T zlR0iv&ilahWE7gBrg8>SVk>#s%D$vxtg~F7Ri|c<+$^uiF+|VfY>QOFzHV{jhm3qR zW29EA)>JT@*VmUyt6bo`WyshxZXDxJp1wlf(HpYSYo)P@iAy6o+P42; zu{6mkAx_%*vr&C@q=wjVr|6sf#zq~32UUYp)5m1MJZhi+C!(gzvIJRdq>clbN<|6TBXxCTB9Z-Q6AiLe1= z9l^n{7swt0;!AKnh`!)Ma6ZgJ4%UP0BbbDz!ya%Sx`W@q|H3!m^B{W*z7bA=0vrix zcm~LR1Aj%w@Kd-Ez6>9Scf)Jp6j%*iAo~vf2ff3$;cB=P&WE#L3y3emq3|5o7aj+4 zM&U2uMvy%T<*dTX;JqN{6x84ZkUFHRe$ba*X$IYO>Z(UtSuML%!Xmc7O5(=5 z?idwz(ik68e_EBMI@Er2Y|L>EuLXmt=1xSacJD0B=*!%%oIcC_=rfbajNCq;O8sc? ziijMt!ptf}J!IdJX|q(;5s1AUlc{5i;q=dOH*D2+x}Rg76@9baSNd*kwM(g&Ri1s> z%NKv_o%5td8`d;EKEk@Ui?@!PS*w||zUQ{yA9ZwWCB62R5ro@W@7Z+H_7mJ-N;CFl z?(`*Gc}M_C5jzweTc=n;g-y?|M@eSlIDxNGXLzY6wOzi^dF~HU$HU;Y@LXf5g39FJ z95S-9&B-oFrhfk1tnzYPUlS2((l~bgx)D9abw25+AR~{g-n4G@@VbpE-@H~Qp7q09 zsq(JM__x*+9yM@fiFNTreWn?=KZ1uDdtD2QroO5xN58Kt|7;FscFDaHj(CA2u6vSPd0OBuRP z(`BhMSRON9B}aRSTSsWiB9VRNIZccRcxA}J5zL=*UgKhV7MqmyB*Z>yLlnbQ=!!*5 z(IvY9M%245!@J8(j=QCj`%O%8L^0&H?D$%xvr}hJM9uQ{B~s6fANk|Dyg5B&XwD+a zzE+biar1YYn}6cd`W~;#mX_nc&#cU@FX{vvbI)&%sUCs4Ib7am&el<;H>4Pc*R6KT zqx}}`q)103GUs!XGh>!j8?NgfLlyz3!CpPlnVk9O5$+G6$+;MlFo4?AZ1)=V Date: Mon, 2 Feb 2026 15:48:35 +0530 Subject: [PATCH 2/9] DOCS-8900 The Backbone and Connection APIs are now deprecated and have been replaced by the Service Provider (SP) Interconnect framework. --- docusaurus.config.ts | 8 +- .../Manage/SP-Interconnect-Manage.yaml | 1481 +++-------------- .../Monitor/SP-Interconnect-Monitor.yaml | 248 +-- .../mt-interconnect/Manage/introduction.md | 21 - .../Manage/manage-introduction.md | 19 + .../Monitor/monitor-introduction.md | 16 +- .../sase/api/mt-interconnect/introduction.md | 33 + products/sase/sidebars.ts | 34 +- 8 files changed, 357 insertions(+), 1503 deletions(-) delete mode 100644 products/sase/api/mt-interconnect/Manage/introduction.md create mode 100644 products/sase/api/mt-interconnect/Manage/manage-introduction.md create mode 100644 products/sase/api/mt-interconnect/introduction.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 222239cf1..62ed49745 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -489,8 +489,8 @@ const config = { icon: "api-doc", }, { - to: "sase/api/mt-interconnect", - label: "Multitenant Interconnect", + to: "sase/api/mt-interconnect/introduction", + label: "Service Provider Interconnect", icon: "api-doc", }, { @@ -924,12 +924,12 @@ const config = { ManageInterconnect: { specPath: "openapi-specs/sase/mt-interconnect/Manage", outputDir: "products/sase/api/mt-interconnect/Manage", - sidebarOptions: { groupPathsBy: "tag" }, + sidebarOptions: { groupPathsBy: "tag",categoryLinkSource: "info" }, }, MonitorInterconnect: { specPath: "openapi-specs/sase/mt-interconnect/Monitor", outputDir: "products/sase/api/mt-interconnect/Monitor", - sidebarOptions: { groupPathsBy: "tag" }, + sidebarOptions: { groupPathsBy: "tag",categoryLinkSource: "info" }, }, manageservices: { specPath: "openapi-specs/sase/manage-services-5g", diff --git a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml index 5455f8445..d13eb4080 100644 --- a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml +++ b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml @@ -2,9 +2,17 @@ openapi: 3.1.0 info: title: SP Interconnect Manage APIs version: '1.0' - description: "This Open API spec file was created on January 28, 2026. \xA9 2026\ - \ Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo\ - \ Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ + description: "These APIs provide the administrative tools necessary to configure\ + \ and manage the lifecycle of Service Provider (SP) Interconnects \nand virtual\ + \ VlanAttachments within the management plane. They enable administrators to establish\ + \ private, secure bridges between Service Providers \nand Prisma Access to bypass\ + \ public cloud backbones. Use these tools during initial deployment or regional\ + \ expansion to provision high-capacity physical and virtual links. \nBy submitting\ + \ specific regional and partner parameters, you can automate the creation of shared\ + \ or dedicated per-tenant infrastructure. This Open API spec file was created\ + \ on February 02, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks\ + \ is a registered trademark of Palo Alto Networks. A list of our trademarks can\ + \ be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ \ All other marks mentioned herein may be trademarks of their respective companies." servers: - url: https://api.sase.paloaltonetworks.com @@ -224,7 +232,7 @@ components: uniqueItems: true items: type: string - pattern: ^((25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})){3})\/(3[0-2]|[1-2][0-9]|[0-9])$ + pattern: ^((25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})){3})/(3[0-2]|[1-2][0-9]|[0-9])$ securitySchemes: authKey: type: http @@ -233,103 +241,18 @@ ExternalTags: {} paths: /mt/sp-interconnect/interconnects: get: - summary: List interconnects - description: List interconnects. + summary: Retrieve All Interconnects + description: Access a complete inventory of Service Provider Interconnects configured + within the multi-tenant environment. This inventory resides in the management + plane and allows administrators to audit existing connectivity across AWS + and GCP providers. Use this during system audits or when mapping regional + resource availability to verify that backbones align with tenant requirements. + Query parameters facilitate targeted searches by including default interconnects + or expanding associated tenant data. operationId: GetMtSp-interconnectInterconnects responses: '200': description: Success - content: - application/json: - examples: - Get interconnects: - value: - data: - - cloudProvider: GCP - id: 1689a56a-9386-40b5-aa9a-0cebad2650d8 - name: new-ic - partnerEmail: acme@abc.com - partnerName: acme - permittedActions: [] - region: us-west2 - regionDisplayName: US Southwest - status: INACTIVE - tenantActivationCount: 0 - tenantType: MT_ROOT - tsgId: '1669501385' - type: PARTNER - usage: SHARED - vlanAttachments: - - bfdEnabled: false - bgpPeerAsn: 9493 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758576695399 - edgeAvailability: AVAILABILITY_DOMAIN_2 - id: d06a04c9-b6aa-4e40-8722-cfee46fc786c - msg: Error getting network from gcp,Not Found - name: test-2 - permittedActions: - - DELETE_CONNECTION - stackType: IPV4_ONLY - state: CREATE_VLAN_ATTACHMENT_FAILED - status: INACTIVE - tenantCount: 0 - updateTime: 1758576779732 - - cloudProvider: GCP - id: 9fbb3e68-1760-4447-a8fa-381a28208477 - name: sp-auto-pt - partnerEmail: sp@example.com - partnerName: equinix - permittedActions: [] - region: europe-southwest1 - regionDisplayName: Andorra - rootTsgId: '1669501385' - status: DELETING - tenantActivationCount: 0 - tenantId: '1033430256' - tenantType: MT_CHILD - tsgId: '1021202872' - type: PARTNER - usage: PER_TENANT - requestId: f6d99966-f98e-484d-a4f2-74237eaf79ab - Get AWS interconnects: - value: - data: - - cloudProvider: AWS - id: 424f9837-68b3-11f0-92e9-4201ac16024e - name: aws-ic-east - partnerEmail: ops@company.com - partnerName: company-ops - permittedActions: - - DELETE_BACKBONE - region: us-east-1 - regionDisplayName: US East - status: ACTIVE - tenantActivationCount: 5 - tenantType: MT_ROOT - tsgId: '1669501385' - type: PARTNER - usage: SHARED - vlanAttachments: - - awsAccountId: '123456789012' - awsConnectionName: dx-connection-1 - bandwidth: BPS_1G - bgpPeerAsn: 65001 - bgpPeerBfdSessionInitMode: ACTIVE - bgpPeerMd5AuthEnabled: true - createTime: 1758576695376 - edgeAvailability: AVAILABILITY_DOMAIN_1 - id: aa465af0-d241-4097-8ee6-31b1c29924f7 - name: aws-vlan-1 - permittedActions: - - DELETE_CONNECTION - stackType: IPV4_ONLY - state: ACTIVE - status: ACTIVE - tenantCount: 3 - updateTime: 1758576695404 - requestId: b66e6d42-0af3-4b92-8ef9-1be242ded8f3 '500': description: Server Error parameters: @@ -342,488 +265,98 @@ paths: schema: type: boolean tags: - - untagged + - Interconnect post: - summary: Create new interconnect - description: Create new interconnect. + summary: Create New Interconnect + description: Provision a top-level Interconnect resource to serve as the logical + container for all subsequent virtual connectivity. This resource creates a + private bridge between a Service Provider and Prisma Access to bypass public + internet routes. Initialize this when onboarding a new region or establishing + isolated per-tenant infrastructure for high-compliance environments. Provide + the cloud provider, region, and usage model (SHARED or PER_TENANT) along with + partner contact details to begin the automated setup process. operationId: PostMtSp-interconnectInterconnects responses: '200': description: Success - content: - application/json: - examples: - Add an interconnect: - value: - data: - cloudProvider: GCP - id: 1689a56a-9386-40b5-aa9a-0cebad2650d8 - name: new-ic - partnerEmail: acme@abc.com - partnerName: acme - permittedActions: [] - region: us-west2 - regionDisplayName: US Southwest - status: INACTIVE - tenantActivationCount: 0 - tenantType: MT_ROOT - tsgId: '1669501385' - type: PARTNER - usage: SHARED - vlanAttachments: - - bfdEnabled: false - bgpPeerAsn: 9493 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758576695376 - edgeAvailability: AVAILABILITY_DOMAIN_1 - id: aa465af0-d241-4097-8ee6-31b1c29924f7 - name: test-1 - permittedActions: [] - stackType: IPV4_ONLY - state: NOT_STARTED - status: INACTIVE - tenantCount: 0 - updateTime: 1758576695404 - - bfdEnabled: false - bgpPeerAsn: 9493 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758576695399 - edgeAvailability: AVAILABILITY_DOMAIN_2 - id: d06a04c9-b6aa-4e40-8722-cfee46fc786c - name: test-2 - permittedActions: [] - stackType: IPV4_ONLY - state: NOT_STARTED - status: INACTIVE - tenantCount: 0 - updateTime: 1758576695404 - requestId: ae1dcb52-7086-4e18-a5a8-8ef8b991c585 '400': description: Bad Request - content: - application/json: - examples: - Add an interconnect with invalid payload: - value: - error: - errorCode: 52046 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Connection input region unsupported - requestId: 3c84be78-eee9-4751-ba03-91759a6e9321 - Invalid interconnect name: - value: - error: - errorCode: 52051 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Name must be lowercase letters,numbers or hyphens; max - length 13 characters - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 - BGP ASN 16550 not allowed: - value: - error: - errorCode: 52028 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: BGP Peer ASN with value 16550 is not allowed - requestId: b2c3d4e5-6f78-9012-bcde-f12345678901 - Missing VPC association: - value: - error: - errorCode: 52003 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Missing VPC association entry for tenant - requestId: c3d4e5f6-7890-1234-cdef-012345678901 '409': description: Conflict - content: - application/json: - examples: - Interconnect already exists: - value: - error: - errorCode: 52004 - errorType: VALIDATION_ERROR - httpStatus: 409 - msg: Interconnect with same usage/cloud_provider/region already - exists - requestId: d4e5f678-9012-3456-def0-123456789012 - Interconnect name exists: - value: - error: - errorCode: 52049 - errorType: VALIDATION_ERROR - httpStatus: 409 - msg: Interconnect with same name already exists - requestId: e5f67890-1234-5678-ef01-234567890123 '500': description: Server Error - content: - application/json: - examples: - Add backbone failed due to internal error: - value: - error: - errorCode: 50002 - errorType: INTERNAL_ERROR - httpStatus: 500 - msg: Failed to add Backbone in db - requestId: 432568e0-05e2-4baa-8595-ed6bb4f98b64 parameters: [] tags: - - untagged + - Interconnect requestBody: content: application/json: schema: $ref: '#/components/schemas/InterconnectRequest' - examples: - Create GCP Partner Interconnect: - value: - name: new-ic - region: us-west2 - partnerName: acme - partnerEmail: acme@abc.com - usage: SHARED - cloudProvider: GCP - type: PARTNER - vlanAttachment: - name: test - bgpPeerAsn: 9493 - bgpPeerBfdSessionInitMode: DISABLED - stackType: IPV4_ONLY - bgpPeerMd5AuthEnabled: false - Create AWS Partner Interconnect: - value: - name: aws-ic - region: us-east-1 - partnerName: equinix - partnerEmail: sp@equinix.com - usage: SHARED - cloudProvider: AWS - type: PARTNER - vlanAttachment: - name: aws-conn-1 - bgpPeerAsn: 65001 - bgpPeerBfdSessionInitMode: ACTIVE - bgpPeerBfdMinTransmitInterval: 1000 - bgpPeerBfdMinReceiveInterval: 1000 - bgpPeerBfdMultiplier: 5 - Create GCP Dedicated Interconnect: - value: - name: ded-ic - region: us-west2 - partnerName: datacenter-ops - partnerEmail: ops@datacenter.com - usage: SHARED - cloudProvider: GCP - type: DEDICATED - vlanAttachment: - name: ded-vlan-1 - bgpPeerAsn: 16363 - bgpPeerBfdSessionInitMode: ACTIVE - bandwidth: BPS_10G - bgpPeerMd5AuthEnabled: true - dedicatedConnectionDetails: - - edgeAvailability: ZONE1 - bandwidth: BPS_10G - - edgeAvailability: ZONE2 - bandwidth: BPS_10G - Create Per-Tenant Interconnect: - value: - name: tenant-ic - region: europe-west1 - partnerName: tenant-partner - partnerEmail: partner@tenant.com - usage: PER_TENANT - tsgId: '1021202872' - cloudProvider: GCP - type: PARTNER - vlanAttachment: - name: tenant-conn - bgpPeerAsn: 65100 - bgpPeerBfdSessionInitMode: DISABLED required: true - /mt/sp-interconnect/interconnects/info: - get: - summary: Get Interconnect Info - description: Get Interconnect Info. - operationId: GetMtSp-interconnectInterconnectsInfo - responses: - '200': - description: Success - content: - application/json: - examples: - Get interconnect info for tenant: - value: - data: - interconnects: - - id: 1689a56a-9386-40b5-aa9a-0cebad2650d8 - name: new-ic - region: us-west2 - regionDisplayName: US Southwest - edgeLocationRegionName: us-west-201 - usage: SHARED - bandwidth: 200Mbps - cloudProvider: GCP - status: ACTIVE - - id: 9fbb3e68-1760-4447-a8fa-381a28208477 - name: aws-ic - region: us-east-1 - regionDisplayName: US East - edgeLocationRegionName: us-east-1a - usage: SHARED - bandwidth: 500Mbps - cloudProvider: AWS - status: ACTIVE - supportedFeatures: - - SP_INTERCONNECT - - DEDICATED_INTERCONNECT - requestId: 82923271-2db3-4895-b1cf-a5faa77d28e3 - Get interconnect info with no interconnects: - value: - data: - interconnects: [] - supportedFeatures: - - SP_INTERCONNECT - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 - '404': - description: Not Found - content: - application/json: - examples: - Tenant not found: - value: - error: - errorCode: 52033 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: The tenant doesn't exist - requestId: d1c5b994-3ce5-4011-acff-498a2080535c - '500': - description: Server Error - parameters: [] - tags: - - untagged /mt/sp-interconnect/interconnects/physical-connections: get: - summary: Get physical connections in interconnect - description: Get physical connections in interconnect. + summary: List Physical Connections + description: Retrieve technical data regarding the underlying hardware links + that support your Interconnects. This visibility allows network engineers + to monitor link speeds (10G/100G) and MACsec encryption status at specific + colocation sites. Access this information when troubleshooting layer-1 connectivity + or performing routine infrastructure health checks. The system returns a list + of physical resources, indicating their current operational status and colocation + zone. operationId: GetMtSp-interconnectInterconnectsPhysical-connections responses: '200': description: Success - content: - application/json: - examples: - Get Physical Connections in a backbone: - value: - data: - - address: "Telehouse - Global Data Centers\n65 Rue L\xE9on Frot\n\ - 75011 Paris\nFrance" - city: Paris - coloFacility: cdg-zone1-53 - ha: false - id: 0c48519e-5738-4719-b2aa-92fcb9e4a96f - linkType: LINK_TYPE_ETHERNET_100G_LR - macSecEnabled: true - permittedActions: - - DELETE_CONNECTION - physicalConnectionName: abc-1 - region: C_EUROPE - requestedLinkCount: 1 - status: PENDING - - address: "Telehouse - Global Data Centers\n65 Rue L\xE9on Frot\n\ - 75011 Paris\nFrance" - city: Paris - coloFacility: cdg-zone2-53 - ha: false - id: fe3bff54-f4b2-4aac-958f-15c60913c9de - linkType: LINK_TYPE_ETHERNET_100G_LR - macSecEnabled: true - permittedActions: - - DELETE_CONNECTION - physicalConnectionName: abc-2 - region: C_EUROPE - requestedLinkCount: 1 - status: PENDING - requestId: 0578a2a6-99a7-4fe6-969f-28eafecb362a '400': description: Bad Request '500': description: Server Error parameters: [] tags: - - untagged + - Physical Connection post: - summary: Create physical connection in an interconnect - description: Create physical connection in an interconnect. + summary: Provision Physical Connection + description: Initiate a physical link request within an Interconnect at a specific + colocation facility. This establishes the core hardware foundation required + before virtual circuits can be provisioned. Use this when expanding regional + bandwidth capacity or establishing a new physical Point of Presence (PoP). + To proceed, define the desired link speed, the link count, and the specific + colocation facility IDs intended for deployment. operationId: PostMtSp-interconnectInterconnectsPhysical-connections responses: '201': description: Success - content: - application/json: - examples: - Add physical connection in backbone: - value: - data: - - address: "Telehouse - Global Data Centers\n65 Rue L\xE9on Frot\n\ - 75011 Paris\nFrance" - city: Paris - coloFacility: cdg-zone1-53 - ha: false - id: 0c48519e-5738-4719-b2aa-92fcb9e4a96f - linkType: LINK_TYPE_ETHERNET_100G_LR - macSecEnabled: true - physicalConnectionName: abc-1 - region: C_EUROPE - requestedLinkCount: 1 - status: PENDING - - address: "Telehouse - Global Data Centers\n65 Rue L\xE9on Frot\n\ - 75011 Paris\nFrance" - city: Paris - coloFacility: cdg-zone2-53 - ha: false - id: fe3bff54-f4b2-4aac-958f-15c60913c9de - linkType: LINK_TYPE_ETHERNET_100G_LR - macSecEnabled: true - physicalConnectionName: abc-2 - region: C_EUROPE - requestedLinkCount: 1 - status: PENDING - requestId: a14eb282-9e97-4cf0-b232-a7c9f4b06fc4 '404': description: Not Found - content: - application/json: - examples: - Add physical connection, interconnect not found: - value: - error: - errorCode: 50004 - errorType: NOT_FOUND - httpStatus: 404 - msg: Interconnect not found! - requestId: d42dba1a-23f1-4818-813b-2da9f35c95bb '400': description: Bad Request - content: - application/json: - examples: - Physical connection name exists: - value: - error: - errorCode: 52105 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Physical Connection name already exists - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 - Invalid link count for 10G: - value: - error: - errorCode: 52109 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: requestedLinkCount for LINK_TYPE_ETHERNET_10G_LR linkType - must be 1 or 2 - requestId: b2c3d4e5-6f78-9012-bcde-f12345678901 - Invalid link count for 100G: - value: - error: - errorCode: 52110 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: requestedLinkCount for LINK_TYPE_ETHERNET_100G_LR linkType - must be from 1-8 - requestId: c3d4e5f6-7890-1234-cdef-012345678901 - Invalid colo facilities count: - value: - error: - errorCode: 52111 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: two entries must be provided in coloFacilities for physical - connection - requestId: d4e5f678-9012-3456-def0-123456789012 '500': description: Server Error - content: - application/json: - examples: - Add physical connection failed: - value: - error: - errorCode: 50018 - errorType: INTERNAL_ERROR - httpStatus: 500 - msg: Failed to add connection in db! - requestId: d42dba1a-23f1-4818-813b-2da9f35c95bb parameters: [] tags: - - untagged + - Physical Connection requestBody: content: application/json: schema: $ref: '#/components/schemas/PhysicalConnectionEntry' - examples: - Create 10G physical connection: - value: - physicalConnectionName: abc-1 - linkType: LINK_TYPE_ETHERNET_10G_LR - requestedLinkCount: 1 - coloFacilities: - - cdg-zone1-53 - - cdg-zone2-53 - macSecEnabled: false - partnerName: datacenter-ops - partnerEmail: ops@datacenter.com - Create 100G physical connection with MACsec: - value: - physicalConnectionName: high-speed-conn - linkType: LINK_TYPE_ETHERNET_100G_LR - requestedLinkCount: 2 - coloFacilities: - - yvr-zone1-1881 - - yvr-zone2-1881 - macSecEnabled: true - partnerName: enterprise-net - partnerEmail: network@enterprise.com required: true /mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}: delete: - summary: Delete physical connection by id - description: Delete connection by id. + summary: Delete Physical Connection + description: Decommission a specific physical link from the environment using + its unique identifier. Terminating these links helps release hardware resources + and end service agreements when specific hardware paths are no longer required. + Execute this during hardware refreshes or regional exit strategies. The system + immediately marks the connection for deletion and initiates the teardown in + the management database and provider portals. operationId: DeleteMtSp-interconnectInterconnectsPhysical-connectionsbyphysicalconnectionid responses: '200': description: Success - content: - application/json: - examples: - Delete Backbone: - value: - data: Successfully marked connection for deletion - requestId: 7e656271-20f3-4fa4-9c4a-e0f455476fe9 '404': description: Not Found - content: - application/json: - examples: - Delete Connection not found: - value: - error: - errorCode: 50007 - errorType: NOT_FOUND - httpStatus: 404 - msg: Connection not found! - requestId: cf32af05-7df6-4dd2-b27e-7b6ef2683145 '400': description: Bad Request '500': @@ -835,48 +368,21 @@ paths: schema: type: string tags: - - untagged + - Physical Connection get: - summary: Get physical connection by Id - description: Get physical connection by Id. + summary: Show Physical Connection + description: View the detailed technical specification of a single physical + link. This displays configuration parameters such as colocation addresses, + HA status, and link types. Use this when preparing for on-site maintenance + at a data center or verifying link readiness before provisioning virtual circuits. + By submitting the physicalConnectionId, you obtain the full state and list + of permitted management actions for that specific resource. operationId: GetMtSp-interconnectInterconnectsPhysical-connectionsbyphysicalconnectionid responses: '200': description: Success - content: - application/json: - examples: - Get Physical Connection by Id: - value: - data: - address: "Telehouse - Global Data Centers\n65 Rue L\xE9on Frot\n\ - 75011 Paris\nFrance" - city: Paris - coloFacility: cdg-zone1-53 - ha: false - id: 0c48519e-5738-4719-b2aa-92fcb9e4a96f - linkType: LINK_TYPE_ETHERNET_100G_LR - macSecEnabled: true - permittedActions: - - DELETE_CONNECTION - physicalConnectionName: abc-1 - region: C_EUROPE - requestedLinkCount: 1 - status: PENDING - requestId: 82923271-2db3-4895-b1cf-a5faa77d28e3 '404': description: Not Found - content: - application/json: - examples: - Get physical connection by Id not found: - value: - error: - errorCode: 50007 - errorType: NOT_FOUND - httpStatus: 404 - msg: Physical Connection not found - requestId: 37e45511-7795-41ad-807f-ec38214e8c30 parameters: - name: physicalConnectionId in: path @@ -888,27 +394,20 @@ paths: schema: type: boolean tags: - - untagged + - Physical Connection /mt/sp-interconnect/interconnects/summary: get: - summary: Get interconnects summary - description: Get interconnects summary. + summary: Summarize All Interconnects + description: View a high-level statistical snapshot of the current Interconnect + ecosystem. This summary provides active/inactive counts, total IP Address + pool usage, and bandwidth distribution across cloud providers. Utilize this + for executive summaries or operational dashboards to monitor global health + at a glance. Filtering by usage type allows you to isolate metrics for SHARED + versus PER_TENANT deployment models. operationId: GetMtSp-interconnectInterconnectsSummary responses: '200': description: Success - content: - application/json: - examples: - Get interconnect summary: - value: - data: - - active: 4 - bandwidth: 20Mbps - cloudProvider: GCP - inactive: 2 - ipPoolCount: 1 - requestId: b66e6d42-0af3-4b92-8ef9-1be242ded8f3 '400': description: Bad Request '500': @@ -919,81 +418,23 @@ paths: schema: $ref: '#/components/schemas/InterconnectUsage' tags: - - untagged + - Interconnect /mt/sp-interconnect/interconnects/{interconnectId}: get: - summary: Get interconnect by Id - description: Get interconnect by Id. + summary: Retrieve Specific Interconnect + description: Fetch the full configuration data and current operational state + of a single Interconnect container. This reveals regional placement, current + status, and the collection of virtual circuits (VlanAttachments) grouped within + the Interconnect. Use this when diagnosing regional connectivity issues or + retrieving internal IDs for sub-resource management. The response details + cloud-specific parameters and optional data regarding tenants currently utilizing + the resource. operationId: GetMtSp-interconnectInterconnectsbyinterconnectid responses: '200': description: Success - content: - application/json: - examples: - Get interconnects by id: - value: - data: - cloudProvider: GCP - id: 1689a56a-9386-40b5-aa9a-0cebad2650d8 - name: new-ic - partnerEmail: acme@abc.com - partnerName: acme - permittedActions: [] - region: us-west2 - regionDisplayName: US Southwest - status: INACTIVE - tenantActivationCount: 0 - tenantType: MT_ROOT - tsgId: '1669501385' - type: PARTNER - usage: SHARED - vlanAttachments: - - bfdEnabled: false - bgpPeerAsn: 9493 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758576695376 - edgeAvailability: AVAILABILITY_DOMAIN_1 - id: aa465af0-d241-4097-8ee6-31b1c29924f7 - msg: Error getting network from gcp,Not Found - name: test-1 - permittedActions: [] - stackType: IPV4_ONLY - state: DELETING - status: INACTIVE - tenantCount: 0 - updateTime: 1758577091897 - - bfdEnabled: false - bgpPeerAsn: 9493 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758576695399 - edgeAvailability: AVAILABILITY_DOMAIN_2 - id: d06a04c9-b6aa-4e40-8722-cfee46fc786c - msg: Error getting network from gcp,Not Found - name: test-2 - permittedActions: - - DELETE_CONNECTION - stackType: IPV4_ONLY - state: CREATE_VLAN_ATTACHMENT_FAILED - status: INACTIVE - tenantCount: 0 - updateTime: 1758576779732 - requestId: 18b1bf70-8b07-42e2-907d-10365382dc63 '404': description: Not Found - content: - application/json: - examples: - Get interconnect by Id, interconnect not found: - value: - error: - errorCode: 52008 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: Interconnect not found - requestId: d1c5b994-3ce5-4011-acff-498a2080535c '400': description: Bad Request '500': @@ -1009,36 +450,23 @@ paths: schema: type: boolean tags: - - untagged + - Interconnect delete: - summary: Delete interconnect by Id - description: Delete interconnect by Id. + summary: Remove Specific Interconnect + description: Permanently remove an Interconnect and its associated configuration + from the environment. This retirees the bridge once all virtual attachments + have been deleted and egress traffic has been rerouted. Execute this only + when a regional Interconnect is no longer required for egress traffic. Success + removes the resource from the database and ends its logical association with + the Prisma Access backend. operationId: DeleteMtSp-interconnectInterconnectsbyinterconnectid responses: '200': description: Success - content: - application/json: - examples: - Delete Interconnect: - value: - data: Successfully Deleted Backbone - requestId: 7e656271-20f3-4fa4-9c4a-e0f455476fe9 '400': description: Bad Request '404': description: Not Found - content: - application/json: - examples: - Delete Interconnect not found: - value: - error: - errorCode: 52008 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: Interconnect not found - requestId: d56d092a-7cb2-4b85-bdbe-48c02c036c94 '500': description: Server Error parameters: @@ -1048,35 +476,21 @@ paths: schema: type: string tags: - - untagged + - Interconnect /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool: put: - summary: Update IP Address Pool - description: Update IP Address Pool. + summary: Update Existing Pool + description: Modify the assigned IP Address blocks or the provider type for + an existing Interconnect pool. This update occurs within the specific Interconnect + context and allows for scaling the number of CIDR blocks as traffic grows. + Use this when expanding Bring Your Own IP Address (BYOIP) capacity or updating + edge location mappings. You must submit the full updated list of IP Address + blocks, specifying their primary or secondary status and the designated edge + location. operationId: PutMtSp-interconnectInterconnectsBy_interconnectidIp-pool responses: '200': description: Success - content: - application/json: - examples: - Update IP Pool: - value: - data: - id: 7673a661-a98b-4202-b70a-8edc3934a3f5 - ipBlocks: - - cidr: - - 21.58.2.0/29 - displayName: Mexico Central - edgeLocation: mexico-central - ipProvider: SP - name: ip-pool-test - permittedActions: [] - region: us-south1 - state: NOT_STARTED - status: PENDING - tsgId: '1091039496' - requestId: 6eb154b3-5ac0-441c-a8e4-a092f5b5b588 '500': description: Internal Error '400': @@ -1088,67 +502,25 @@ paths: schema: type: string tags: - - untagged + - IP Pool requestBody: content: application/json: schema: $ref: '#/components/schemas/IPPoolRequest' - examples: - Update IP Pool with new CIDRs: - value: - ipProvider: SP - ipBlocks: - - edgeLocation: mexico-central - cidr: - - 21.58.2.0/29 - - 21.58.3.0/29 - type: SECONDARY - Add additional edge location: - value: - ipProvider: SP - ipBlocks: - - edgeLocation: us-west-1 - cidr: - - 12.2.2.0/26 - type: SECONDARY - - edgeLocation: us-east-1 - cidr: - - 12.3.3.0/26 - type: SECONDARY required: true get: - summary: Get IP Address pool by id - description: Get IP Address pool by id. + summary: Retrieve IP Address Pool + description: View the current IP Address address configuration assigned to an + Interconnect, including CIDR ranges and provider status. This provides visibility + into the addressing scheme used at the edge for egress routing. Access this + to verify that the correct SP-provided or public IP Address ranges are in + effect. The data returned includes the IP Address pool ID, its provisioning + state, and a list of all active CIDR blocks. operationId: GetMtSp-interconnectInterconnectsBy_interconnectidIp-pool responses: '200': description: Success - content: - application/json: - examples: - Get IP Pool by id: - value: - data: - cloudProvider: AWS - createTime: 1748207866258 - id: 64753c22-8234-4d06-8410-2fc7a949a8f5 - interconnectId: 424f9837-68b3-11f0-92e9-4201ac16024e - ipBlocks: - - cidr: - - 18.2.1.0/28 - displayName: US Northwest - edgeLocation: us-west-2 - type: SECONDARY - ipProvider: SP - permittedActions: - - ASSIGN_IP_POOL - - DELETE_IP_POOL - - UPDATE_IP_POOL - state: NOT_STARTED - status: PENDING - updateTime: 1748207866258 - requestId: 7d7de6bc-f96b-4cd7-bad4-fb7a5689eba7 '400': description: Bad Request parameters: @@ -1158,21 +530,19 @@ paths: schema: type: string tags: - - untagged + - IP Pool delete: - summary: Delete IP Address pool by id - description: Delete IP Address pool by id. + summary: Delete IP Address Pool + description: Remove all IP Address block associations and provider settings + from the specified Interconnect. Terminating the pool stops the use of specific + CIDRs for routing and returns the container to an unassigned state. Use this + when retiring BYOIP ranges or preparing to swap service provider IP Address + schemes. Note that deleting an active pool will immediately impact egress + traffic relying on those addresses. operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidIp-pool responses: '200': description: Success - content: - application/json: - examples: - Delete IP Pool by id: - value: - data: IP Pool successfully deleted - requestId: e34443d5-dfbd-482b-a76c-5d753034efc0 parameters: - name: interconnectId in: path @@ -1180,86 +550,21 @@ paths: schema: type: string tags: - - untagged + - IP Pool post: - summary: Create new IP Address Pool - description: Create new IP Address Pool. + summary: Create New Pool + description: Provision and attach a new IP Address address pool to an existing + Interconnect. This defines the addressing model (SP-provided or PANW-provided) + that Prisma Access traffic will use at the edge. Use this when finalizing + the egress setup for a new regional Interconnect container. When using SP-provided + pools, you must include at least one valid public CIDR block mapped to a supported + edge location. operationId: PostMtSp-interconnectInterconnectsBy_interconnectidIp-pool responses: '201': description: Success - content: - application/json: - examples: - Add an IP Pool: - value: - data: - cloudProvider: GCP - createTime: 1758577740021 - id: 3dec9dea-c100-495b-9fb2-16b44c1eae3a - interconnectId: 1689a56a-9386-40b5-aa9a-0cebad2650d8 - ipBlocks: - - cidr: - - 12.2.2.0/26 - displayName: US West - edgeLocation: us-west-1 - type: SECONDARY - - cidr: - - 12.1.2.0/26 - edgeLocation: us-west2 - type: PRIMARY - ipProvider: SP - permittedActions: [] - state: VALIDATING_CIDR_IN_ORCHESTRATOR - status: IN_PROGRESS - updateTime: 1758577740331 - requestId: 8c085ae4-bf26-4de5-86bd-2ba446b65d47 '400': description: Bad Request - content: - application/json: - examples: - CIDR already used: - value: - error: - errorCode: 52070 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: CIDR is already used - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 - Private IP not allowed: - value: - error: - errorCode: 52068 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: CIDR in IP Pool is private IP, only public IPs allowed - requestId: b2c3d4e5-6f78-9012-bcde-f12345678901 - Max CIDRs reached: - value: - error: - errorCode: 52071 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Only ten cidr blocks allowed per edge location - requestId: c3d4e5f6-7890-1234-cdef-012345678901 - IP Pool already exists: - value: - error: - errorCode: 52013 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: IP Pool already exists in interconnect - requestId: d4e5f678-9012-3456-def0-123456789012 - Invalid CIDR range for GCP: - value: - error: - errorCode: 52123 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: GCP CloudProvider IP Block CIDRs must be between /25 to - /29 - requestId: e5f67890-1234-5678-ef01-234567890123 '500': description: Internal Error parameters: @@ -1269,81 +574,25 @@ paths: schema: type: string tags: - - untagged + - IP Pool requestBody: content: application/json: schema: $ref: '#/components/schemas/IPPoolRequest' - examples: - Create SP provided IP Pool: - value: - ipProvider: SP - ipBlocks: - - edgeLocation: us-west-1 - cidr: - - 12.2.2.0/26 - type: SECONDARY - - edgeLocation: us-west2 - cidr: - - 12.1.2.0/26 - type: PRIMARY - Create PANW provided IP Pool: - value: - ipProvider: PANW - Create AWS IP Pool: - value: - ipProvider: SP - ipBlocks: - - edgeLocation: us-east-1a - cidr: - - 18.2.1.0/28 - - 18.2.2.0/28 - type: SECONDARY required: true /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments: get: - summary: List vlan attachment in an interconnect - description: List vlan attachment in an interconnect. + summary: List Vlan Attachments + description: Retrieve all virtual circuits configured within a specific Interconnect. + This allows administrators to verify the regional distribution of attachments + and their current BGP states. Use this when auditing high-availability (HA) + domains or verifying pairing key availability. The response lists BGP parameters, + edge availability domains, and current provisioning states for each circuit. operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachments responses: '200': description: Success - content: - application/json: - examples: - Get vlan attachments in an interconnect: - value: - data: - - bfdEnabled: false - bgpPeerAsn: 16363 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758575564100 - edgeAvailability: AVAILABILITY_DOMAIN_2 - id: 0182b459-6ddd-41cc-9f45-60af08e7ec2b - name: test-2 - permittedActions: [] - stackType: IPV4_ONLY - state: NOT_STARTED - status: INACTIVE - tenantCount: 0 - updateTime: 1758575564106 - - bfdEnabled: false - bgpPeerAsn: 16363 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758575564075 - edgeAvailability: AVAILABILITY_DOMAIN_1 - id: 73d4c1c1-ee4a-4fc3-98f0-45e465c17c5e - name: test-1 - permittedActions: [] - stackType: IPV4_ONLY - state: NOT_STARTED - status: INACTIVE - tenantCount: 0 - updateTime: 1758575564082 - requestId: 21f951d8-0d34-48cb-ae3e-29fcc5339bea '400': description: Bad Request '500': @@ -1355,100 +604,23 @@ paths: schema: type: string tags: - - untagged + - Vlan Attachment post: - summary: Create vlan attachment in an interconnect - description: Create vlan attachment in an interconnect. + summary: Provision Vlan Attachment + description: Create a new virtual circuit, known as a VlanAttachment, within + an Interconnect to enable data transfer. This establishes the actual logical + path for Prisma Access traffic routing through the Service Provider. Deploy + this when initializing new egress paths or adding redundant links for regional + reliability. Required parameters include a unique name, BGP Peer ASN, and + BFD initialization mode to ensure robust connectivity. operationId: PostMtSp-interconnectInterconnectsBy_interconnectidVlan-attachments responses: '201': description: Success - content: - application/json: - examples: - Add vlan attachment in interconnect: - value: - data: - - bfdEnabled: false - bgpPeerAsn: 16363 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758575564075 - edgeAvailability: AVAILABILITY_DOMAIN_1 - id: 73d4c1c1-ee4a-4fc3-98f0-45e465c17c5e - name: test-1 - permittedActions: [] - stackType: IPV4_ONLY - state: NOT_STARTED - status: INACTIVE - tenantCount: 0 - updateTime: 1758575564077 - - bfdEnabled: false - bgpPeerAsn: 16363 - bgpPeerBfdSessionInitMode: DISABLED - bgpPeerMd5AuthEnabled: false - createTime: 1758575564100 - edgeAvailability: AVAILABILITY_DOMAIN_2 - id: 0182b459-6ddd-41cc-9f45-60af08e7ec2b - name: test-2 - permittedActions: [] - stackType: IPV4_ONLY - state: NOT_STARTED - status: INACTIVE - tenantCount: 0 - updateTime: 1758575564101 - requestId: 73811958-f1a9-4a3e-b5f1-b9373eeb4000 '404': description: Not Found - content: - application/json: - examples: - Add vlan attachment, interconnect not found: - value: - error: - errorCode: 52008 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: Interconnect not found - requestId: 95203e0e-e0f7-49ef-9b9d-04c9ba42e95b '400': description: Bad Request - content: - application/json: - examples: - VLAN attachment name exists: - value: - error: - errorCode: 52011 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Connection name already exists - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 - Max vlan attachments reached: - value: - error: - errorCode: 52018 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Reached maximum number of vlan attachments in an interconnect - requestId: b2c3d4e5-6f78-9012-bcde-f12345678901 - Dedicated connection details missing: - value: - error: - errorCode: 52025 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: dedicatedVlanAttachmentDetails cannot be null for Connection - with type DEDICATED - requestId: c3d4e5f6-7890-1234-cdef-012345678901 - Bandwidth required for dedicated: - value: - error: - errorCode: 52026 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Bandwidth is required input for dedicated VLAN Attachment - requestId: d4e5f678-9012-3456-def0-123456789012 '500': description: Server Error parameters: @@ -1458,80 +630,26 @@ paths: schema: type: string tags: - - untagged + - Vlan Attachment requestBody: content: application/json: schema: $ref: '#/components/schemas/VlanAttachmentRequest' - examples: - Create Partner VLAN attachment: - value: - name: test - bgpPeerAsn: 16550 - bgpPeerBfdSessionInitMode: DISABLED - stackType: IPV4_ONLY - bgpPeerMd5AuthEnabled: false - Create VLAN attachment with BFD enabled: - value: - name: bfd-conn - bgpPeerAsn: 65001 - bgpPeerBfdSessionInitMode: ACTIVE - bgpPeerBfdMinTransmitInterval: 1000 - bgpPeerBfdMinReceiveInterval: 1000 - bgpPeerBfdMultiplier: 5 - stackType: IPV4_ONLY - bgpPeerMd5AuthEnabled: true - Create VLAN attachment with IPv4/IPv6: - value: - name: dual-stack - bgpPeerAsn: 64512 - bgpPeerBfdSessionInitMode: PASSIVE - stackType: IPV4_IPV6 - bgpPeerMd5AuthEnabled: false - Create Dedicated VLAN attachment: - value: - name: ded-vlan - bgpPeerAsn: 16363 - bgpPeerBfdSessionInitMode: ACTIVE - bandwidth: BPS_10G - stackType: IPV4_ONLY - bgpPeerMd5AuthEnabled: true - dedicatedConnectionDetails: - - edgeAvailability: ZONE1 - bandwidth: BPS_10G - - edgeAvailability: ZONE2 - bandwidth: BPS_10G required: true /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}: get: - summary: Get vlan attachment in an interconnect - description: Get vlan attachment in an interconnect. + summary: Show Vlan Attachment + description: View the full technical specification of a single virtual circuit + by its unique identifier. This displays parameters such as MD5 authentication, + BGP session timers, and stack type (IPv4/Dual-Stack). Use this to verify pairing + key generation or to inspect the specific edge availability domain assigned + for redundancy. The returned data provides the exact state needed for alignment + with service provider configurations. operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsbyvlanattachmentid responses: '200': description: Success - content: - application/json: - examples: - Get vlan attachment by Id: - value: - data: - bandwidth: BPS_50M - bgpPeerAsn: 16550 - edgeAvailability: ZONE1 - id: dee52272-d1e2-4b88-9ebc-a5e70e414d58 - name: abc-edge-1 - partnerEmail: sp@mail.com - partnerName: sp_abc_name - region: us-central1 - state: CREATED_CONNECTION - status: PENDING - bgpPeerBfdMinReceiveInterval: 1000 - bgpPeerBfdMinTransmitInterval: 1000 - bgpPeerBfdMultiplier: 5 - bgpPeerMd5AuthEnabled: true - requestId: 138de731-25c2-4001-8ea5-d81992c146d7 '400': description: Bad Request '500': @@ -1548,34 +666,20 @@ paths: schema: type: string tags: - - untagged + - Vlan Attachment delete: - summary: Delete vlan attachment in an interconnect - description: Delete vlan attachment in an interconnect. + summary: Delete Vlan Attachment + description: Permanently remove a specific virtual circuit and its logical configuration + from the Interconnect. Terminating these circuits is necessary when network + paths are being replaced or retired. Execute this during scheduled maintenance + windows or regional re-architecting. Ensure the paired service provider resource + is also manually decommissioned to prevent unintended billing. operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsbyvlanattachmentid responses: '200': description: Success - content: - application/json: - examples: - Delete vlan attachment by Id: - value: - data: Successfully delete VLAN Attachment - requestId: 7e656271-20f3-4fa4-9c4a-e0f455476fe9 '404': description: Not Found - content: - application/json: - examples: - Delete vlan attachment, interconnect not found: - value: - error: - errorCode: 52008 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: Interconnect not found - requestId: d56d092a-7cb2-4b85-bdbe-48c02c036c94 '400': description: Bad Request '500': @@ -1592,78 +696,25 @@ paths: schema: type: string tags: - - untagged + - Vlan Attachment /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/accept: post: - summary: Accept vlanAttachment - description: Accept vlanAttachment (AWS connections only). + summary: Accept AWS Attachment + description: Transition a pending AWS Direct Connect attachment into the accepted + state within the management plane. This serves as the final confirmation required + by AWS to activate the virtual circuit. Trigger this action when the circuit + state reaches PENDING_SP_ACCEPTANCE in the AWS console. Note that this action + is exclusive to AWS deployments and cannot be used for GCP or other providers. operationId: PostMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentidAccept responses: '200': description: Success - content: - application/json: - examples: - Accept AWS vlan attachment: - value: - data: Successfully accepted VLAN Attachment - requestId: 7e656271-20f3-4fa4-9c4a-e0f455476fe9 '400': description: Bad Request - content: - application/json: - examples: - Accept non-AWS vlan attachment: - value: - error: - errorCode: 52047 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Connections created in AWS can be accepted - requestId: 95203e0e-e0f7-49ef-9b9d-04c9ba42e95b - Accept vlan attachment not in pending state: - value: - error: - errorCode: 52046 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: VlanAttachment can be accepted only in PENDING_SP_ACCEPTANCE - state - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 '404': description: Not Found - content: - application/json: - examples: - Interconnect not found: - value: - error: - errorCode: 52008 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: Interconnect not found - requestId: d56d092a-7cb2-4b85-bdbe-48c02c036c94 - Vlan attachment not found: - value: - error: - errorCode: 52029 - errorType: VALIDATION_ERROR - httpStatus: 404 - msg: Vlan Attachment not found - requestId: cf32af05-7df6-4dd2-b27e-7b6ef2683145 '500': description: Server Error - content: - application/json: - examples: - Accept AWS vlan attachment failed: - value: - error: - errorCode: 52048 - errorType: INTERNAL_ERROR - httpStatus: 500 - msg: Failed to accept vlan attachment in aws - requestId: d42dba1a-23f1-4818-813b-2da9f35c95bb parameters: - name: interconnectId in: path @@ -1676,65 +727,24 @@ paths: schema: type: string tags: - - untagged + - Vlan Attachment /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/logs: get: - summary: Get cloudRouter logs for vlan attachment from startTime to endTime - milliseconds - description: Get cloudRouter logs for vlan attachment from startTime to endTime - milliseconds. + summary: Fetch Router Logs + description: Retrieve real-time CloudRouter logs for virtual attachments deployed + on the GCP network. These logs provide critical data on BGP session stability, + peer adjacency events, and routing updates. Use this during initial deployment + or when troubleshooting regional connectivity drops. You must provide a valid + lookback duration (e.g., 1h, 1d); this feature is not supported for AWS-based + attachments. operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentidLogs responses: '200': description: Success - content: - application/json: - examples: - Get cloud router logs: - value: - data: - logs: - - timestamp: 1758576695399 - severity: INFO - message: BGP session established with peer 10.0.0.1 - - timestamp: 1758576779732 - severity: WARNING - message: BGP hold timer expired, resetting session - requestId: 82923271-2db3-4895-b1cf-a5faa77d28e3 '400': description: Bad Request - content: - application/json: - examples: - Invalid duration: - value: - error: - errorCode: 52091 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Invalid duration, allowed duration are 15m, 1h, 1d, 3d - requestId: 95203e0e-e0f7-49ef-9b9d-04c9ba42e95b - Logs not supported for AWS: - value: - error: - errorCode: 52092 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: CloudRouter logs supported only for GCP connections - requestId: a1b2c3d4-5e6f-7890-abcd-ef1234567890 '500': description: Server Error - content: - application/json: - examples: - Failed to get logs: - value: - error: - errorCode: 52090 - errorType: INTERNAL_ERROR - httpStatus: 500 - msg: Failed getting cloud router logs from GCP - requestId: d42dba1a-23f1-4818-813b-2da9f35c95bb parameters: - name: interconnectId in: path @@ -1758,180 +768,85 @@ paths: - 1d - 3d tags: - - untagged + - Vlan Attachment /mt/sp-interconnect/regions: get: - summary: Get list of regions and edgeLocations - description: Get regions and edgeLocations. + summary: List Available Regions + description: Fetch the master list of all geographical regions and edge locations + supported by the SP Interconnect service. This assists in network planning + by identifying optimal locations for Interconnect placement. Consult this + data to determine the closest edge location to your physical infrastructure + for low-latency traffic egress. The response is dynamically filtered based + on the cloudProvider to ensure regional compatibility. operationId: GetMtSp-interconnectRegions responses: '200': description: Success - content: - application/json: - examples: - Get IP Pool regions/edge locations: - value: - data: - - edge_locations: - - display_name: US Southwest - edge_location: us-west-201 - - display_name: US West - edge_location: us-west-1 - compute_region: us-west2 - theater: North Americas - - edge_locations: - - display_name: US Central West - edge_location: us-west-3 - compute_region: us-west3 - theater: North Americas - requestId: e459bba9-ca17-4bfa-a55a-f7305a7e8f75 parameters: - name: cloudProvider in: query schema: $ref: '#/components/schemas/CloudProvider' tags: - - untagged + - Interconnect /mt/sp-interconnect/regions/physical-connections: get: - summary: Get list of physical connection regions - description: Get list of physical connection regions. + summary: List GCP Regions + description: Retrieve the specific regions and colocation facilities available + for physical interconnect deployments on the GCP network. This informs network + engineers of the precise locations where high-speed physical links can be + provisioned. Use this when developing a dedicated physical connectivity strategy + for large-scale multi-tenant environments. The data provides a hierarchy of + continents, cities, and specific facility names. operationId: GetMtSp-interconnectRegionsPhysical-connections responses: '200': description: Success - content: - application/json: - examples: - Get regions for Physical Interconencts in GCP: - value: - data: - regions: - - cities: - - coloFacilities: - - address: 'Cologix, Inc. - - 1050 W Pender Street - - Vancouver, V6E 3S7 - - Canada - - ' - city: Vancouver - continent: C_NORTH_AMERICA - description: Cologix VAN2 - status: AVAILABLE - zones: - - availabilityZone: zone1 - facilityProvider: Cologix - facilityProviderFacilityId: Cologix - id: 1377 - name: yvr-zone1-1881 - peeringdbFacilityId: '1881' - selfLink: https://www.googleapis.com/compute/v1/projects/host-gpcs-dev-01/global/interconnectLocations/yvr-zone1-1881 - status: AVAILABLE - - availabilityZone: zone2 - facilityProvider: Cologix - facilityProviderFacilityId: Cologix - id: 1378 - name: yvr-zone2-1881 - peeringdbFacilityId: '1881' - selfLink: https://www.googleapis.com/compute/v1/projects/host-gpcs-dev-01/global/interconnectLocations/yvr-zone2-1881 - status: AVAILABLE - name: Vancouver - region: C_NORTH_AMERICA - requestId: 709de72e-8004-41c8-9dc5-9d9b852876c4 parameters: [] tags: - - untagged + - Interconnect /mt/sp-interconnect/settings: post: - summary: Add egressType and cidr details for tsgId - description: Add egressType and cidr details for tsgId. + summary: Configure Egress Settings + description: Apply traffic routing preferences and egress behavior for a specific + Tenant Service Group (TSG). This determines whether egress traffic utilizes + the private Service Provider (SP) path or the standard Prisma Access (PA) + path. Set this during tenant onboarding or when modifying existing regional + traffic policies. If SP egress is selected, you must specify the CIDR ranges + that should participate in the private routing. operationId: PostMtSp-interconnectSettings responses: '200': description: Success - content: - application/json: - examples: - Update Egress type and cidr: - value: - data: - cidr: - - 2.1.1.1/29 - - 3.2.2.2/29 - egressType: SP - requestId: 996e250d-e1bc-4499-a408-7ccbfdda0368 '400': description: Bad Request - content: - application/json: - examples: - Update Egress type and cidr failed on not vpc entry: - value: - error: - errorCode: 52003 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Missing VPC association entry for tenant - requestId: c33354e9-6fd0-491d-9dac-010240132fed '409': description: Conflict parameters: [] tags: - - untagged + - Interconnect requestBody: content: application/json: schema: $ref: '#/components/schemas/SettingsEntry' - examples: - Set SP egress type with CIDRs: - value: - egressType: SP - cidr: - - 2.1.1.1/29 - - 3.2.2.2/29 - Set PA egress type: - value: - egressType: PA required: true get: - summary: Get Settings - description: Get Settings. + summary: Show Egress Settings + description: View the current egress and routing configuration for the authenticated + tenant context. This verifies whether the tenant is currently utilizing the + SP Interconnect or the default public path for their egress traffic. Access + this to validate that your network architecture policies have been correctly + applied at the management plane. The response provides the egress type and + all participating CIDR blocks. operationId: GetMtSp-interconnectSettings responses: '200': description: Success - content: - application/json: - examples: - Get Egress type and cidr: - value: - data: - cidr: - - 3.2.2.2/29 - - 2.1.1.1/29 - egressType: SP - requestId: d10ee1b0-b8ed-461b-af14-dfad5a782dc5 '400': description: Bad Request - content: - application/json: - examples: - Get Egress type and cidr failed on not vpc entry: - value: - error: - errorCode: 52030 - errorType: VALIDATION_ERROR - httpStatus: 400 - msg: Tenant does not have shared vpc assigned - requestId: 130cb837-b3d8-43af-b15f-cd60724cab8d '404': description: Not Found parameters: [] tags: - - untagged + - Interconnect diff --git a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml index a48d00a0e..8d63dcd1f 100644 --- a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml +++ b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml @@ -2,9 +2,16 @@ openapi: 3.1.0 info: title: SP Interconnect Manage APIs version: '1.0' - description: "This Open API spec file was created on January 28, 2026. \xA9 2026\ - \ Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark of Palo\ - \ Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ + description: "These APIs deliver real-time visibility and performance analytics\ + \ for all configured interconnect \nresources through the monitoring plane. They\ + \ allow network teams to track health, bandwidth throughput, \nand data transfer\ + \ volumes at the edge to ensure optimal network security and reliability. \nAccess\ + \ these metrics during routine audits or active troubleshooting to diagnose latency\ + \ spikes or BGP session instability. \nBy applying time-based filters and histograms,\ + \ you can generate detailed traffic trends and monitor IP pool consumption across\ + \ your global infrastructure. This Open API spec file was created on February\ + \ 02, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered\ + \ trademark of Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ \ All other marks mentioned herein may be trademarks of their respective companies." servers: - url: https://api.sase.paloaltonetworks.com @@ -20,34 +27,19 @@ ExternalTags: {} paths: /mt/sp-interconnect/monitor/vlanAttachments/stats: post: - summary: Get VLAN Attachment Stats - description: Returns statistics for VLAN attachments including throughput and - connection details. + summary: Get Vlan Attachment Statistics + description: "Retrieve granular performance metrics and operational metadata\ + \ for virtual circuits within the multi-tenant interconnect framework. This\ + \ data resides in the monitoring plane and provides visibility into throughput,\ + \ BGP states, and uptime for specific regional attachments. Access these statistics\ + \ during health audits or when verifying that provisioned bandwidth aligns\ + \ with actual consumption. To execute, define the desired properties\u2014\ + such as ingress/egress throughput or cloud router IPs\u2014and apply filters\ + \ based on time ranges or specific interconnect IDs." operationId: PostMtSp-interconnectMonitorVlanattachmentsStats responses: '200': description: Success - content: - application/json: - example: - data: - - cloudProvider: GCP - cloudRouterIp: 169.254.23.177/29 - cloudRouterIpv6: 2600:2d00:0:1:8000:25:4:7879/125 - createTime: 1737611965296 - egress_throughput: 0.0011975343058471016 - ingress_throughput: 0.0017068013320864356 - interconnect_id: c4ac1cc9-684e-11f0-92e9-4201ac16024e - interconnect_name: ic-us-east1 - region: us-east1 - state: ACTIVE_BGP_UP_BGP_IPV6_UP - status: ACTIVE - tenants: 0 - up_time: 1763134414000 - updateTime: 1763755310226 - vlan_attachment_id: 9764ced6-ef10-437e-80a4-d7609dee6264 - vlan_attachment_name: us-east-1-add-2 - requestId: 45759649-4f0f-41b7-a8d2-766f924eaf67 '400': description: Bad Request '401': @@ -84,33 +76,18 @@ paths: /mt/sp-interconnect/monitor/interconnects/traffic: post: summary: Get Interconnect Data Transfer - description: Returns egress and ingress traffic data for interconnects. Use - lifetime=true query parameter for lifetime traffic data. + description: Aggregate data transfer volumes for entire Interconnect containers + to track total network consumption. This information is calculated at the + edge locations and allows administrators to monitor data egress and ingress + for billing or capacity planning. Utilize this for monthly usage reports or + when analyzing long-term traffic trends across SHARED or PER_TENANT models. + You can retrieve either specific windowed data or total lifetime traffic by + toggling the lifetime query parameter and defining the appropriate time-based + filters. operationId: PostMtSp-interconnectMonitorInterconnectsTraffic responses: '200': description: Success - content: - application/json: - examples: - Egress Traffic: - value: - data: - - interconnect_name: ic-us-central1 - egress_traffic: 73.40927790249995 - requestId: c39c2083-2aa0-4255-9b22-d87c75ec6ade - Traffic Over Time: - value: - data: - - interconnect_name: ic-us-central1 - event_time: 1763424000000 - egress_traffic: 25.912407871000052 - ingress_traffic: 50.45267106150007 - - interconnect_name: ic-us-central1 - event_time: 1763510400000 - egress_traffic: 26.001434308999958 - ingress_traffic: 48.22614097999999 - requestId: c9369eee-108d-4ab8-8498-15bcbb6cf55e '400': description: Bad Request '401': @@ -148,72 +125,20 @@ paths: operator: equals values: - c4ac1d7a-684e-11f0-92e9-4201ac16024e - Traffic Over Time: - value: - properties: - - property: egress_traffic - function: sum - - property: ingress_traffic - function: sum - - property: interconnect_name - sort: - order: asc - filter: - operator: AND - rules: - - property: event_time - operator: last_n_days - values: - - 30 - - property: interconnect_id - operator: in - values: - - c4ac1d7a-684e-11f0-92e9-4201ac16024e - histogram: - property: event_time - range: day - enableEmptyInterval: false - value: '1' - Lifetime Traffic: - value: - properties: - - property: interconnect_name - sort: - order: asc - - function: sum - property: egress_traffic - filter: - operator: AND - rules: - - property: event_time - operator: lessThan - values: - - '1766104066466' - - property: interconnect_id - operator: equals - values: - - c4ac1d7a-684e-11f0-92e9-4201ac16024e /mt/sp-interconnect/monitor/interconnects/throughput: post: - summary: Get Throughput by Interconnect - description: Returns throughput trends for interconnects over time. + summary: Get Throughput By Interconnect + description: Monitor the real-time and historical throughput rates for designated + Interconnect resources. This metric tracks the speed of data flow across the + Service Provider bridge to identify potential bottlenecks or underutilized + capacity. Access this when performing performance tuning or when investigating + regional latency issues. To proceed, define the throughput properties and + use the histogram object to group data by time intervals, such as daily or + hourly trends. operationId: PostMtSp-interconnectMonitorInterconnectsThroughput responses: '200': description: Success - content: - application/json: - example: - data: - - egress_throughput: 0.002407656942160277 - ingress_throughput: 0.004687820775191641 - event_time: 1763424000000 - interconnect_name: ic-us-central1 - - egress_throughput: 0.0024075402109722268 - ingress_throughput: 0.0044653834247916635 - event_time: 1763510400000 - interconnect_name: ic-us-central1 - requestId: 3fb923a8-0077-443b-a334-07b3cd2123ed '400': description: Bad Request '401': @@ -250,25 +175,18 @@ paths: value: '1' /mt/sp-interconnect/monitor/vlanAttachments/throughput: post: - summary: Get VLAN Attachment Throughput Trends - description: Returns throughput trends for VLAN attachments over time. + summary: Get Vlan Attachment Throughput Trends + description: Track throughput performance specifically for individual virtual + circuits within an Interconnect. This provides granular visibility into the + load distribution across multiple VlanAttachments to ensure high-availability + (HA) domains are operating as expected. Use this when diagnosing specific + circuit failures or verifying that a new attachment is carrying traffic correctly. + Define the VlanAttachment ID and apply a time-based histogram to visualize + throughput shifts over the desired monitoring period. operationId: PostMtSp-interconnectMonitorVlanattachmentsThroughput responses: '200': description: Success - content: - application/json: - example: - data: - - vlan_attachment_name: us-centrl-con-2 - event_time: 1763424000000 - egress_throughput: 0.0012025526091289183 - ingress_throughput: 0.0019499224276655067 - - vlan_attachment_name: us-centrl-con-2 - event_time: 1763510400000 - egress_throughput: 0.001203609572708337 - ingress_throughput: 0.0017978866898611117 - requestId: 8bcffcf2-5cba-4ed6-bc63-ed1e8a60bec6 '400': description: Bad Request '401': @@ -306,25 +224,18 @@ paths: value: '1' /mt/sp-interconnect/monitor/vlanAttachments/traffic: post: - summary: Get VLAN Attachment Traffic Trends - description: Returns traffic trends for VLAN attachments over time. + summary: Get Vlan Attachment Traffic Trends + description: Analyze traffic volume trends for specific virtual circuits over + time. This function captures the total amount of data processed by a VlanAttachment, + assisting in usage-based auditing or capacity forecasting for regional egress. + Deploy this when identifying which virtual circuits are the primary contributors + to regional data transfer. Provide the unique circuit identifier and specify + the aggregation function, such as a sum of egress traffic, to generate a time-series + traffic report. operationId: PostMtSp-interconnectMonitorVlanattachmentsTraffic responses: '200': description: Success - content: - application/json: - example: - data: - - vlan_attachment_name: us-centrl-con-2 - event_time: 1763424000000 - egress_traffic: 12.942472452499988 - ingress_traffic: 20.98604013349996 - - vlan_attachment_name: us-centrl-con-2 - event_time: 1763510400000 - egress_traffic: 12.99898336799997 - ingress_traffic: 19.417176225000027 - requestId: 3291624f-4e40-4b10-9a9c-9851c8bbbd82 '400': description: Bad Request '401': @@ -362,26 +273,18 @@ paths: value: '1' /mt/sp-interconnect/monitor/vlanAttachments/latency: post: - summary: Get VLAN Attachment Latency Trends - description: Returns latency trends for VLAN attachments over time. + summary: Get Vlan Attachment Latency Trends + description: Monitor latency performance for virtual circuits to ensure network + paths meet required service levels. This metric measures the delay in traffic + traversal between Prisma Access and the Service Provider edge. Access this + during troubleshooting to determine if network slowness is related to the + private Interconnect path rather than internal cloud routing. Specify the + vlan_attachment_id and utilize a daily or hourly histogram to detect latency + spikes or persistent high-delay trends. operationId: PostMtSp-interconnectMonitorVlanattachmentsLatency responses: '200': description: Success - content: - application/json: - example: - data: - - vlan_attachment_name: us-centrl-con-2 - event_time: 1766016000000 - latency: 4.204661846160889 - - vlan_attachment_name: us-centrl-con-2 - event_time: 1765238400000 - latency: 3.15822172164917 - - vlan_attachment_name: us-centrl-con-2 - event_time: 1764115200000 - latency: 4.052086353302002 - requestId: 8e701533-5ab3-4815-90af-b4da543804a9 '400': description: Bad Request '401': @@ -418,36 +321,17 @@ paths: /mt/sp-interconnect/monitor/ip-pool-usage: get: summary: Get IP Address Pool Usage - description: Returns IP Address pool usage statistics for an interconnect. + description: Retrieve consumption statistics for the IP Address address pools + assigned to an Interconnect. This visibility helps prevent IP Address exhaustion + by tracking the percentage of used versus configured addresses across primary + and secondary blocks. Use this when monitoring regional IP Address resources + or when investigating incidents related to IP Address address unavailability. + By submitting a valid interconnectId, you receive data on used IPs, incident + counts, and pool locations for the specified resource. operationId: GetMtSp-interconnectMonitorIp-pool-usage responses: '200': description: Success - content: - application/json: - example: - data: - - configuredIps: 16 - createTime: 1734992147821 - incidentCount: 1 - ipBlockType: SECONDARY - ipProvider: SP - location: US Central - percentageUsed: 100 - region: us-central1 - updateTime: 1734992205233 - usedIps: 16 - - configuredIps: 4 - createTime: 1734992147821 - incidentCount: 1 - ipBlockType: PRIMARY - ipProvider: SP - location: US Central - percentageUsed: 100 - region: us-central1 - updateTime: 1734992205233 - usedIps: 4 - requestId: 4c06b78f-caa4-4be9-ab90-c58c3855bd8c '400': description: Bad Request '401': diff --git a/products/sase/api/mt-interconnect/Manage/introduction.md b/products/sase/api/mt-interconnect/Manage/introduction.md deleted file mode 100644 index 20fcd1a97..000000000 --- a/products/sase/api/mt-interconnect/Manage/introduction.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: introduction -title: Multitenant Interconnect Manage APIs -sidebar_label: Multitenant Interconnect Manage APIs -slug: /sase/api/mt-interconnect -keywords: - - SASE - - Reference - - API ---- - -Welcome to the Strata Cloud Manager Multitenant Service Provider Interconnect APIs. The Service -Provider (SP) Interconnect API allows you to use Service Provider Backbones like BT, Orange, AT&T, -and more for directing Prisma Access egress traffic. Without the SP Interconnect, Prisma Access -egress traffic relies on public cloud providers like GCP, AWS, and Azure for network backbone -connectivity. The SP Interconnect API offers several benefits, including enhanced security,optimized -network costs, and reliability. You can easily manage traffic routing preferences on a per-SP and -per-Prisma Access location or region basis, ensuring flexibility and efficiency in network -operations. - -These APIs use the [common SASE authentication](/sase/docs/getstarted) for service access and authorization. diff --git a/products/sase/api/mt-interconnect/Manage/manage-introduction.md b/products/sase/api/mt-interconnect/Manage/manage-introduction.md new file mode 100644 index 000000000..4eb07a458 --- /dev/null +++ b/products/sase/api/mt-interconnect/Manage/manage-introduction.md @@ -0,0 +1,19 @@ +--- +id: manage-introduction +title: Multitenant Interconnect Manage APIs +sidebar_label: Multitenant Interconnect Manage APIs +keywords: + - SASE + - Reference + - API +--- + +The **SP Interconnect Manage** API allows you to configure and manage the lifecycle of your service provider connectivity. + +## Key Management Functions +* **Interconnect Models**: Configure **Shared Interconnects** for multi-tenant egress or **Per-Tenant Interconnects** for isolated child tenant ingress. +* **VlanAttachment Lifecycle**: Provision virtual circuits within specific regions and retrieve **Vlan Pairing Keys** for co-location providers. +* **IP Pool Management**: Manage **IPPools** for traffic routing, including **Bring Your Own IP (BYOIP)** support. +* **Egress Paths**: Define if egress traffic returns to the SP network or uses Prisma Access egress. + +These APIs use the [common SASE authentication](/sase/docs/getstarted) for service access and authorization. diff --git a/products/sase/api/mt-interconnect/Monitor/monitor-introduction.md b/products/sase/api/mt-interconnect/Monitor/monitor-introduction.md index 01470bfb9..d15790e82 100644 --- a/products/sase/api/mt-interconnect/Monitor/monitor-introduction.md +++ b/products/sase/api/mt-interconnect/Monitor/monitor-introduction.md @@ -2,20 +2,18 @@ id: monitor-introduction title: Multitenant Interconnect Monitor APIs sidebar_label: Multitenant Interconnect Monitor APIs -slug: /sase/api/mt-interconnect keywords: - SASE - Reference - API --- -Welcome to the Strata Cloud Manager Multitenant Service Provider Interconnect APIs. The Service -Provider (SP) Interconnect API allows you to use Service Provider Backbones like BT, Orange, AT&T, -and more for directing Prisma Access egress traffic. Without the SP Interconnect, Prisma Access -egress traffic relies on public cloud providers like GCP, AWS, and Azure for network backbone -connectivity. The SP Interconnect API offers several benefits, including enhanced security,optimized -network costs, and reliability. You can easily manage traffic routing preferences on a per-SP and -per-Prisma Access location or region basis, ensuring flexibility and efficiency in network -operations. +The **SP Interconnect Monitoring** API provides real-time visibility into the health, performance, and consumption of your infrastructure. + +## Key Monitoring Metrics +* **Interconnect Health**: Monitor operational status across all regions to detect disruptions. +* **VlanAttachment Status**: Track the connectivity state and performance of virtual circuits. +* **IP Pool Usage**: Gain insights into IP address pool consumption to prevent exhaustion. +* **Multi-tenant Visibility**: View monitoring summaries across all tenants to identify regional issues. These APIs use the [common SASE authentication](/sase/docs/getstarted) for service access and authorization. diff --git a/products/sase/api/mt-interconnect/introduction.md b/products/sase/api/mt-interconnect/introduction.md new file mode 100644 index 000000000..d100fd7e2 --- /dev/null +++ b/products/sase/api/mt-interconnect/introduction.md @@ -0,0 +1,33 @@ +--- +id: introduction +title: Service Provider Interconnect APIs +sidebar_label: Service Provider Interconnect Overview +keywords: + - SASE + - Reference + - API +--- + +**Deprecation Notice** + +The **Backbone** and **Connection** APIs are now **deprecated** and have been replaced by the **Service Provider (SP) Interconnect** framework. + +**Key Terminology Changes:** +* **Backbone** is now **Interconnect**. +* **Connection** is now **VlanAttachment**. +* **Physical Connection** is now **Physical VlanAttachment**. + +**What You Should Do:** +1. **Migrate Endpoints:** Update API calls to the new `/sp-interconnect/` directory structure. +2. **Update Resources:** Align internal logic with the new **SHARED** and **PER_TENANT** types. + +## Overview +Welcome to the **Strata Cloud Manager Multitenant Service Provider (SP) Interconnect APIs**. + +The SP Interconnect API allows you to use Service Provider Interconnects (e.g., BT, Orange, AT&T) for directing Prisma Access egress traffic. Without SP Interconnect, traffic relies on public cloud backbones like GCP, AWS, and Azure. This framework provides enhanced security, optimized costs, and improved reliability. + +## Key Components +* **Interconnects**: The top-level resource grouping connectivity by region and cloud provider. +* **VlanAttachments**: Virtual circuits (formerly "Connections") that facilitate data flow. +* **Physical VlanAttachments**: Underlying physical infrastructure mapping. +* **IPPools**: Managed IP sets attached directly to an Interconnect. \ No newline at end of file diff --git a/products/sase/sidebars.ts b/products/sase/sidebars.ts index 771dc8fe5..f98cf2e01 100644 --- a/products/sase/sidebars.ts +++ b/products/sase/sidebars.ts @@ -299,11 +299,37 @@ module.exports = { "sase/api/mt-notifications/notifications-api", require("./api/mt-notifications/sidebar"), ], - sasemtinterconnect: [ - "sase/api/mt-interconnect/Manage/introduction", - "sase/api/mt-interconnect/Monitor/monitor-introduction", - require("./api/mt-interconnect/Manage/sidebar"), + + // UNIFIED SP INTERCONNECT SIDEBAR + spinterconnect: [ + // 1. Root Introduction (Must exist at: sase/api/mt-interconnect/introduction.md) + "sase/api/mt-interconnect/introduction", + + // 2. Manage Category + { + type: "category", + label: "Manage", + collapsed: false, + items: [ + // Ensure the ID in manage-introduction.md is exactly "manage-introduction" + "sase/api/mt-interconnect/Manage/manage-introduction", + ...require("./api/mt-interconnect/Manage/sidebar"), + ], + }, + + // 3. Monitor Category + { + type: "category", + label: "Monitor", + collapsed: false, + items: [ + // Ensure the ID in monitor-introduction.md is exactly "monitor-introduction" + "sase/api/mt-interconnect/Monitor/monitor-introduction", + ...require("./api/mt-interconnect/Monitor/sidebar"), + ], + }, ], + manageservices: [ "sase/api/manage-services-5g/introduction_5g", "sase/api/manage-services-5g/overview_5g", From 1846709fa73ab5b5749afa06078f53f68652d5ba Mon Sep 17 00:00:00 2001 From: sra Date: Mon, 2 Feb 2026 16:05:09 +0530 Subject: [PATCH 3/9] Added Deprecation notice block in the intro file and updated changelog --- products/sase/api/mt-interconnect/introduction.md | 5 +++-- products/sase/docs/release-notes/changelog.md | 1 + products/scm/docs/release-notes/changelog.md | 1 + 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/products/sase/api/mt-interconnect/introduction.md b/products/sase/api/mt-interconnect/introduction.md index d100fd7e2..d3a05e82d 100644 --- a/products/sase/api/mt-interconnect/introduction.md +++ b/products/sase/api/mt-interconnect/introduction.md @@ -7,8 +7,7 @@ keywords: - Reference - API --- - -**Deprecation Notice** +:::warning Deprecation Notice The **Backbone** and **Connection** APIs are now **deprecated** and have been replaced by the **Service Provider (SP) Interconnect** framework. @@ -21,6 +20,8 @@ The **Backbone** and **Connection** APIs are now **deprecated** and have been re 1. **Migrate Endpoints:** Update API calls to the new `/sp-interconnect/` directory structure. 2. **Update Resources:** Align internal logic with the new **SHARED** and **PER_TENANT** types. +::: + ## Overview Welcome to the **Strata Cloud Manager Multitenant Service Provider (SP) Interconnect APIs**. diff --git a/products/sase/docs/release-notes/changelog.md b/products/sase/docs/release-notes/changelog.md index 3bf669872..ea5340651 100644 --- a/products/sase/docs/release-notes/changelog.md +++ b/products/sase/docs/release-notes/changelog.md @@ -13,6 +13,7 @@ keywords: | Date | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Febuary 2, 2026 | Redesigned the [SP Interconnect APIs](/sase/api/mt-interconnect/introduction.md). | Oct 8, 2025 | Added new APIs to [SASE 5G Manage Services APIs](/sase/api/manage-services-5g/). | July 1, 2025 | Added [Identity Security Posture Management APIs](/sase/api/identity-sspm/). | June 24, 2025 | Added Plugin API to [SaaS Security Posture Management APIs](/sase/api/sspm/). diff --git a/products/scm/docs/release-notes/changelog.md b/products/scm/docs/release-notes/changelog.md index 87c191917..0d58629a9 100644 --- a/products/scm/docs/release-notes/changelog.md +++ b/products/scm/docs/release-notes/changelog.md @@ -12,6 +12,7 @@ keywords: | Date | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Febuary 2, 2026 | Added [CIE Directory Sync Service APIs](/scm/api/config/ciedss/ciedss/). | October 21, 2025 | Added [CIE Directory Sync Service APIs](/scm/api/config/ciedss/ciedss/). | June 27, 2025 | Added [Snippet Sharing APIs](/scm/api/config/sase/setup/snippet-sharing/). | May 20, 2025 | Introduced two policies Security and Internet for Security Rules under [Security Services APIs](/scm/api/config/sase/security/security-api/). From 1a2c4ac1d9357beb98f9b7434514d339140f996e Mon Sep 17 00:00:00 2001 From: sra Date: Mon, 2 Feb 2026 17:38:04 +0530 Subject: [PATCH 4/9] Removed categoryLinkSource: "info" for manage and monitor --- docusaurus.config.ts | 4 ++-- products/sase/docs/release-notes/changelog.md | 2 +- products/scm/docs/release-notes/changelog.md | 1 - 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 62ed49745..fee318279 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -924,12 +924,12 @@ const config = { ManageInterconnect: { specPath: "openapi-specs/sase/mt-interconnect/Manage", outputDir: "products/sase/api/mt-interconnect/Manage", - sidebarOptions: { groupPathsBy: "tag",categoryLinkSource: "info" }, + sidebarOptions: { groupPathsBy: "tag" }, }, MonitorInterconnect: { specPath: "openapi-specs/sase/mt-interconnect/Monitor", outputDir: "products/sase/api/mt-interconnect/Monitor", - sidebarOptions: { groupPathsBy: "tag",categoryLinkSource: "info" }, + sidebarOptions: { groupPathsBy: "tag" }, }, manageservices: { specPath: "openapi-specs/sase/manage-services-5g", diff --git a/products/sase/docs/release-notes/changelog.md b/products/sase/docs/release-notes/changelog.md index ea5340651..dc0c33273 100644 --- a/products/sase/docs/release-notes/changelog.md +++ b/products/sase/docs/release-notes/changelog.md @@ -13,7 +13,7 @@ keywords: | Date | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Febuary 2, 2026 | Redesigned the [SP Interconnect APIs](/sase/api/mt-interconnect/introduction.md). +| February 2, 2026 | Redesigned the [SP Interconnect APIs](/sase/api/mt-interconnect/introduction.md). | Oct 8, 2025 | Added new APIs to [SASE 5G Manage Services APIs](/sase/api/manage-services-5g/). | July 1, 2025 | Added [Identity Security Posture Management APIs](/sase/api/identity-sspm/). | June 24, 2025 | Added Plugin API to [SaaS Security Posture Management APIs](/sase/api/sspm/). diff --git a/products/scm/docs/release-notes/changelog.md b/products/scm/docs/release-notes/changelog.md index 0d58629a9..87c191917 100644 --- a/products/scm/docs/release-notes/changelog.md +++ b/products/scm/docs/release-notes/changelog.md @@ -12,7 +12,6 @@ keywords: | Date | Description | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Febuary 2, 2026 | Added [CIE Directory Sync Service APIs](/scm/api/config/ciedss/ciedss/). | October 21, 2025 | Added [CIE Directory Sync Service APIs](/scm/api/config/ciedss/ciedss/). | June 27, 2025 | Added [Snippet Sharing APIs](/scm/api/config/sase/setup/snippet-sharing/). | May 20, 2025 | Introduced two policies Security and Internet for Security Rules under [Security Services APIs](/scm/api/config/sase/security/security-api/). From 82c3cba0e412911f7ecf66fcf49066df7f972025 Mon Sep 17 00:00:00 2001 From: sra Date: Wed, 4 Feb 2026 18:07:07 +0530 Subject: [PATCH 5/9] DOCS-8900 Addressed first review comments. Fixed response/request body display error. --- .../Manage/SP-Interconnect-Manage.yaml | 14 +++++++------- .../Monitor/SP-Interconnect-Monitor.yaml | 2 +- products/sase/api/mt-interconnect/introduction.md | 1 - 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml index d13eb4080..7a7645480 100644 --- a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml +++ b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml @@ -10,7 +10,7 @@ info: \ expansion to provision high-capacity physical and virtual links. \nBy submitting\ \ specific regional and partner parameters, you can automate the creation of shared\ \ or dedicated per-tenant infrastructure. This Open API spec file was created\ - \ on February 02, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks\ + \ on February 04, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks\ \ is a registered trademark of Palo Alto Networks. A list of our trademarks can\ \ be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ \ All other marks mentioned herein may be trademarks of their respective companies." @@ -370,7 +370,7 @@ paths: tags: - Physical Connection get: - summary: Show Physical Connection + summary: Get Physical Connection description: View the detailed technical specification of a single physical link. This displays configuration parameters such as colocation addresses, HA status, and link types. Use this when preparing for on-site maintenance @@ -510,7 +510,7 @@ paths: $ref: '#/components/schemas/IPPoolRequest' required: true get: - summary: Retrieve IP Address Pool + summary: Get IP Address Address Pool description: View the current IP Address address configuration assigned to an Interconnect, including CIDR ranges and provider status. This provides visibility into the addressing scheme used at the edge for egress routing. Access this @@ -639,7 +639,7 @@ paths: required: true /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}: get: - summary: Show Vlan Attachment + summary: Get Vlan Attachment description: View the full technical specification of a single virtual circuit by its unique identifier. This displays parameters such as MD5 authentication, BGP session timers, and stack type (IPv4/Dual-Stack). Use this to verify pairing @@ -771,7 +771,7 @@ paths: - Vlan Attachment /mt/sp-interconnect/regions: get: - summary: List Available Regions + summary: List of Regions and Edge Locations description: Fetch the master list of all geographical regions and edge locations supported by the SP Interconnect service. This assists in network planning by identifying optimal locations for Interconnect placement. Consult this @@ -791,7 +791,7 @@ paths: - Interconnect /mt/sp-interconnect/regions/physical-connections: get: - summary: List GCP Regions + summary: List of Physical Connection Regions in GCP description: Retrieve the specific regions and colocation facilities available for physical interconnect deployments on the GCP network. This informs network engineers of the precise locations where high-speed physical links can be @@ -832,7 +832,7 @@ paths: $ref: '#/components/schemas/SettingsEntry' required: true get: - summary: Show Egress Settings + summary: Get Egress Settings description: View the current egress and routing configuration for the authenticated tenant context. This verifies whether the tenant is currently utilizing the SP Interconnect or the default public path for their egress traffic. Access diff --git a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml index 8d63dcd1f..edcd5eb13 100644 --- a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml +++ b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml @@ -10,7 +10,7 @@ info: \ spikes or BGP session instability. \nBy applying time-based filters and histograms,\ \ you can generate detailed traffic trends and monitor IP pool consumption across\ \ your global infrastructure. This Open API spec file was created on February\ - \ 02, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered\ + \ 04, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered\ \ trademark of Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ \ All other marks mentioned herein may be trademarks of their respective companies." servers: diff --git a/products/sase/api/mt-interconnect/introduction.md b/products/sase/api/mt-interconnect/introduction.md index d3a05e82d..ec37cd37b 100644 --- a/products/sase/api/mt-interconnect/introduction.md +++ b/products/sase/api/mt-interconnect/introduction.md @@ -14,7 +14,6 @@ The **Backbone** and **Connection** APIs are now **deprecated** and have been re **Key Terminology Changes:** * **Backbone** is now **Interconnect**. * **Connection** is now **VlanAttachment**. -* **Physical Connection** is now **Physical VlanAttachment**. **What You Should Do:** 1. **Migrate Endpoints:** Update API calls to the new `/sp-interconnect/` directory structure. From 388450c79dc2912af28372526514f115ae35beab Mon Sep 17 00:00:00 2001 From: sra Date: Wed, 4 Feb 2026 18:07:07 +0530 Subject: [PATCH 6/9] DOCS-8900 Addressed first review comments. Fixed response/request body display error. --- .../Manage/SP-Interconnect-Manage.yaml | 14 +++++++------- .../Monitor/SP-Interconnect-Monitor.yaml | 2 +- products/sase/api/mt-interconnect/introduction.md | 1 - 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml index d13eb4080..7a7645480 100644 --- a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml +++ b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml @@ -10,7 +10,7 @@ info: \ expansion to provision high-capacity physical and virtual links. \nBy submitting\ \ specific regional and partner parameters, you can automate the creation of shared\ \ or dedicated per-tenant infrastructure. This Open API spec file was created\ - \ on February 02, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks\ + \ on February 04, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks\ \ is a registered trademark of Palo Alto Networks. A list of our trademarks can\ \ be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ \ All other marks mentioned herein may be trademarks of their respective companies." @@ -370,7 +370,7 @@ paths: tags: - Physical Connection get: - summary: Show Physical Connection + summary: Get Physical Connection description: View the detailed technical specification of a single physical link. This displays configuration parameters such as colocation addresses, HA status, and link types. Use this when preparing for on-site maintenance @@ -510,7 +510,7 @@ paths: $ref: '#/components/schemas/IPPoolRequest' required: true get: - summary: Retrieve IP Address Pool + summary: Get IP Address Address Pool description: View the current IP Address address configuration assigned to an Interconnect, including CIDR ranges and provider status. This provides visibility into the addressing scheme used at the edge for egress routing. Access this @@ -639,7 +639,7 @@ paths: required: true /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}: get: - summary: Show Vlan Attachment + summary: Get Vlan Attachment description: View the full technical specification of a single virtual circuit by its unique identifier. This displays parameters such as MD5 authentication, BGP session timers, and stack type (IPv4/Dual-Stack). Use this to verify pairing @@ -771,7 +771,7 @@ paths: - Vlan Attachment /mt/sp-interconnect/regions: get: - summary: List Available Regions + summary: List of Regions and Edge Locations description: Fetch the master list of all geographical regions and edge locations supported by the SP Interconnect service. This assists in network planning by identifying optimal locations for Interconnect placement. Consult this @@ -791,7 +791,7 @@ paths: - Interconnect /mt/sp-interconnect/regions/physical-connections: get: - summary: List GCP Regions + summary: List of Physical Connection Regions in GCP description: Retrieve the specific regions and colocation facilities available for physical interconnect deployments on the GCP network. This informs network engineers of the precise locations where high-speed physical links can be @@ -832,7 +832,7 @@ paths: $ref: '#/components/schemas/SettingsEntry' required: true get: - summary: Show Egress Settings + summary: Get Egress Settings description: View the current egress and routing configuration for the authenticated tenant context. This verifies whether the tenant is currently utilizing the SP Interconnect or the default public path for their egress traffic. Access diff --git a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml index 8d63dcd1f..edcd5eb13 100644 --- a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml +++ b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml @@ -10,7 +10,7 @@ info: \ spikes or BGP session instability. \nBy applying time-based filters and histograms,\ \ you can generate detailed traffic trends and monitor IP pool consumption across\ \ your global infrastructure. This Open API spec file was created on February\ - \ 02, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered\ + \ 04, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered\ \ trademark of Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ \ All other marks mentioned herein may be trademarks of their respective companies." servers: diff --git a/products/sase/api/mt-interconnect/introduction.md b/products/sase/api/mt-interconnect/introduction.md index d3a05e82d..ec37cd37b 100644 --- a/products/sase/api/mt-interconnect/introduction.md +++ b/products/sase/api/mt-interconnect/introduction.md @@ -14,7 +14,6 @@ The **Backbone** and **Connection** APIs are now **deprecated** and have been re **Key Terminology Changes:** * **Backbone** is now **Interconnect**. * **Connection** is now **VlanAttachment**. -* **Physical Connection** is now **Physical VlanAttachment**. **What You Should Do:** 1. **Migrate Endpoints:** Update API calls to the new `/sp-interconnect/` directory structure. From d86314f813ea82520247c60ac5071edfcdd8a2dd Mon Sep 17 00:00:00 2001 From: sra Date: Wed, 4 Feb 2026 18:50:48 +0530 Subject: [PATCH 7/9] Updated the script to render response/request payload --- .../Manage/SP-Interconnect-Manage.yaml | 839 +++++++++--------- .../Monitor/SP-Interconnect-Monitor.yaml | 193 ++-- 2 files changed, 508 insertions(+), 524 deletions(-) diff --git a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml index 7a7645480..8f88d1455 100644 --- a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml +++ b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml @@ -9,238 +9,13 @@ info: \ public cloud backbones. Use these tools during initial deployment or regional\ \ expansion to provision high-capacity physical and virtual links. \nBy submitting\ \ specific regional and partner parameters, you can automate the creation of shared\ - \ or dedicated per-tenant infrastructure. This Open API spec file was created\ - \ on February 04, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks\ - \ is a registered trademark of Palo Alto Networks. A list of our trademarks can\ - \ be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ - \ All other marks mentioned herein may be trademarks of their respective companies." -servers: -- url: https://api.sase.paloaltonetworks.com -security: -- authKey: [] -components: - schemas: - CloudProvider: - type: string - enum: - - GCP - - AWS - ConnectionType: - type: string - enum: - - DEDICATED - - PARTNER - DedicatedVlanAttachmentDetailsEntry: - type: object - properties: - edgeAvailability: - type: string - bandwidth: - $ref: '#/components/schemas/Bandwidth' - required: - - edgeAvailability - InterconnectRequest: - type: object - required: - - name - - region - - partnerName - - partnerEmail - - usage - - cloudProvider - - type - properties: - name: - type: string - pattern: ^([-0-9a-z]){1,13}$ - region: - type: string - pattern: \\S+ - partnerName: - type: string - pattern: ^([a-zA-Z0-9\s\-]){1,30}$ - partnerEmail: - type: string - pattern: \\S - usage: - $ref: '#/components/schemas/InterconnectUsage' - tsgId: - type: string - pattern: ^[0-9-]+$ - cloudProvider: - $ref: '#/components/schemas/CloudProvider' - type: - $ref: '#/components/schemas/ConnectionType' - ipPool: - $ref: '#/components/schemas/IPPoolRequest' - physicalConnection: - $ref: '#/components/schemas/PhysicalConnectionEntry' - vlanAttachment: - $ref: '#/components/schemas/VlanAttachmentRequest' - InterconnectUsage: - type: string - enum: - - SHARED - - PER_TENANT - IPPoolRequest: - type: object - required: - - ipProvider - properties: - ipBlocks: - type: array - uniqueItems: true - items: - $ref: '#/components/schemas/IPBlockEntry' - ipProvider: - $ref: '#/components/schemas/IPProvider' - IPBlockEntry: - type: object - required: - - cidr - properties: - edgeLocation: - type: string - cidr: - type: array - minItems: 1 - uniqueItems: true - items: - type: string - type: - $ref: '#/components/schemas/IPBlockType' - IPBlockType: - type: string - enum: - - PRIMARY - - SECONDARY - IPProvider: - type: string - enum: - - SP - - PANW - PhysicalConnectionEntry: - type: object - required: - - physicalConnectionName - - linkType - - coloFacilities - - partnerName - - partnerEmail - properties: - physicalConnectionName: - type: string - pattern: \\S - linkType: - $ref: '#/components/schemas/PhysicalInterconnectLinkType' - requestedLinkCount: - type: integer - format: int32 - coloFacilities: - type: array - minItems: 1 - items: - type: string - macSecEnabled: - type: boolean - partnerName: - type: string - pattern: \\S - partnerEmail: - type: string - pattern: \\S - PhysicalInterconnectLinkType: - type: string - enum: - - LINK_TYPE_ETHERNET_10G_LR - - LINK_TYPE_ETHERNET_100G_LR - VlanAttachmentRequest: - type: object - required: - - name - - bgpPeerAsn - - bgpPeerBfdSessionInitMode - properties: - name: - type: string - pattern: ^([-0-9a-z]){1,13}$ - stackType: - $ref: '#/components/schemas/StackType' - bandwidth: - $ref: '#/components/schemas/Bandwidth' - bgpPeerAsn: - type: integer - format: int64 - minimum: 1 - bgpPeerBfdSessionInitMode: - $ref: '#/components/schemas/SessionInitializationMode' - bgpPeerBfdMinTransmitInterval: - type: integer - format: int64 - maximum: 30000 - minimum: 1000 - bgpPeerBfdMinReceiveInterval: - type: integer - format: int64 - maximum: 30000 - minimum: 1000 - bgpPeerBfdMultiplier: - type: integer - format: int64 - maximum: 16 - minimum: 5 - dedicatedConnectionDetails: - type: array - items: - $ref: '#/components/schemas/DedicatedVlanAttachmentDetailsEntry' - bgpPeerMd5AuthEnabled: - type: boolean - StackType: - type: string - enum: - - IPV4_ONLY - - IPV4_IPV6 - Bandwidth: - type: string - enum: - - BPS_50M - - BPS_100M - - BPS_200M - - BPS_300M - - BPS_400M - - BPS_500M - - BPS_1G - - BPS_2G - - BPS_5G - - BPS_10G - SessionInitializationMode: - type: string - enum: - - ACTIVE - - PASSIVE - - DISABLED - SettingsEntry: - type: object - required: - - egressType - properties: - egressType: - type: string - pattern: SP|PA - cidr: - type: array - uniqueItems: true - items: - type: string - pattern: ^((25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})){3})/(3[0-2]|[1-2][0-9]|[0-9])$ - securitySchemes: - authKey: - type: http - scheme: Bearer -ExternalTags: {} + \ or dedicated per-tenant infrastructure. This spec was created on February 04,\ + \ 2026. \xA9 2026 Palo Alto Networks, Inc." paths: /mt/sp-interconnect/interconnects: get: + tags: + - Interconnect summary: Retrieve All Interconnects description: Access a complete inventory of Service Provider Interconnects configured within the multi-tenant environment. This inventory resides in the management @@ -249,12 +24,6 @@ paths: resource availability to verify that backbones align with tenant requirements. Query parameters facilitate targeted searches by including default interconnects or expanding associated tenant data. - operationId: GetMtSp-interconnectInterconnects - responses: - '200': - description: Success - '500': - description: Server Error parameters: - name: includeDefaultInterconnect in: query @@ -264,9 +33,15 @@ paths: in: query schema: type: boolean + responses: + '200': + description: Success + '500': + description: Server Error + operationId: GetMtSp-interconnectInterconnects + post: tags: - Interconnect - post: summary: Create New Interconnect description: Provision a top-level Interconnect resource to serve as the logical container for all subsequent virtual connectivity. This resource creates a @@ -275,7 +50,12 @@ paths: isolated per-tenant infrastructure for high-compliance environments. Provide the cloud provider, region, and usage model (SHARED or PER_TENANT) along with partner contact details to begin the automated setup process. - operationId: PostMtSp-interconnectInterconnects + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InterconnectRequest' + required: true responses: '200': description: Success @@ -285,17 +65,11 @@ paths: description: Conflict '500': description: Server Error - parameters: [] - tags: - - Interconnect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InterconnectRequest' - required: true + operationId: PostMtSp-interconnectInterconnects /mt/sp-interconnect/interconnects/physical-connections: get: + tags: + - Physical Connection summary: List Physical Connections description: Retrieve technical data regarding the underlying hardware links that support your Interconnects. This visibility allows network engineers @@ -304,7 +78,6 @@ paths: or performing routine infrastructure health checks. The system returns a list of physical resources, indicating their current operational status and colocation zone. - operationId: GetMtSp-interconnectInterconnectsPhysical-connections responses: '200': description: Success @@ -312,10 +85,10 @@ paths: description: Bad Request '500': description: Server Error - parameters: [] + operationId: GetMtSp-interconnectInterconnectsPhysical-connections + post: tags: - Physical Connection - post: summary: Provision Physical Connection description: Initiate a physical link request within an Interconnect at a specific colocation facility. This establishes the core hardware foundation required @@ -323,7 +96,12 @@ paths: bandwidth capacity or establishing a new physical Point of Presence (PoP). To proceed, define the desired link speed, the link count, and the specific colocation facility IDs intended for deployment. - operationId: PostMtSp-interconnectInterconnectsPhysical-connections + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PhysicalConnectionEntry' + required: true responses: '201': description: Success @@ -333,17 +111,11 @@ paths: description: Bad Request '500': description: Server Error - parameters: [] - tags: - - Physical Connection - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PhysicalConnectionEntry' - required: true + operationId: PostMtSp-interconnectInterconnectsPhysical-connections /mt/sp-interconnect/interconnects/physical-connections/{physicalConnectionId}: delete: + tags: + - Physical Connection summary: Delete Physical Connection description: Decommission a specific physical link from the environment using its unique identifier. Terminating these links helps release hardware resources @@ -351,7 +123,12 @@ paths: Execute this during hardware refreshes or regional exit strategies. The system immediately marks the connection for deletion and initiates the teardown in the management database and provider portals. - operationId: DeleteMtSp-interconnectInterconnectsPhysical-connectionsbyphysicalconnectionid + parameters: + - name: physicalConnectionId + in: path + required: true + schema: + type: string responses: '200': description: Success @@ -361,28 +138,17 @@ paths: description: Bad Request '500': description: Server Error - parameters: - - name: physicalConnectionId - in: path - required: true - schema: - type: string + operationId: DeleteMtSp-interconnectInterconnectsPhysical-connectionsBy_physicalconnectionid + get: tags: - Physical Connection - get: summary: Get Physical Connection description: View the detailed technical specification of a single physical link. This displays configuration parameters such as colocation addresses, HA status, and link types. Use this when preparing for on-site maintenance - at a data center or verifying link readiness before provisioning virtual circuits. - By submitting the physicalConnectionId, you obtain the full state and list - of permitted management actions for that specific resource. - operationId: GetMtSp-interconnectInterconnectsPhysical-connectionsbyphysicalconnectionid - responses: - '200': - description: Success - '404': - description: Not Found + at a data center or verifying link readiness before provisioning virtual circuits. + By submitting the physicalConnectionId, you obtain the full state and list + of permitted management actions for that specific resource. parameters: - name: physicalConnectionId in: path @@ -393,10 +159,16 @@ paths: in: query schema: type: boolean - tags: - - Physical Connection + responses: + '200': + description: Success + '404': + description: Not Found + operationId: GetMtSp-interconnectInterconnectsPhysical-connectionsBy_physicalconnectionid /mt/sp-interconnect/interconnects/summary: get: + tags: + - Interconnect summary: Summarize All Interconnects description: View a high-level statistical snapshot of the current Interconnect ecosystem. This summary provides active/inactive counts, total IP Address @@ -404,7 +176,11 @@ paths: for executive summaries or operational dashboards to monitor global health at a glance. Filtering by usage type allows you to isolate metrics for SHARED versus PER_TENANT deployment models. - operationId: GetMtSp-interconnectInterconnectsSummary + parameters: + - name: usage + in: query + schema: + $ref: '#/components/schemas/InterconnectUsage' responses: '200': description: Success @@ -412,15 +188,11 @@ paths: description: Bad Request '500': description: Server Error - parameters: - - name: usage - in: query - schema: - $ref: '#/components/schemas/InterconnectUsage' - tags: - - Interconnect + operationId: GetMtSp-interconnectInterconnectsSummary /mt/sp-interconnect/interconnects/{interconnectId}: get: + tags: + - Interconnect summary: Retrieve Specific Interconnect description: Fetch the full configuration data and current operational state of a single Interconnect container. This reveals regional placement, current @@ -429,16 +201,6 @@ paths: retrieving internal IDs for sub-resource management. The response details cloud-specific parameters and optional data regarding tenants currently utilizing the resource. - operationId: GetMtSp-interconnectInterconnectsbyinterconnectid - responses: - '200': - description: Success - '404': - description: Not Found - '400': - description: Bad Request - '500': - description: Server Error parameters: - name: interconnectId in: path @@ -449,9 +211,19 @@ paths: in: query schema: type: boolean + responses: + '200': + description: Success + '404': + description: Not Found + '400': + description: Bad Request + '500': + description: Server Error + operationId: GetMtSp-interconnectInterconnectsBy_interconnectid + delete: tags: - Interconnect - delete: summary: Remove Specific Interconnect description: Permanently remove an Interconnect and its associated configuration from the environment. This retirees the bridge once all virtual attachments @@ -459,7 +231,12 @@ paths: when a regional Interconnect is no longer required for egress traffic. Success removes the resource from the database and ends its logical association with the Prisma Access backend. - operationId: DeleteMtSp-interconnectInterconnectsbyinterconnectid + parameters: + - name: interconnectId + in: path + required: true + schema: + type: string responses: '200': description: Success @@ -469,16 +246,11 @@ paths: description: Not Found '500': description: Server Error - parameters: - - name: interconnectId - in: path - required: true - schema: - type: string - tags: - - Interconnect + operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectid /mt/sp-interconnect/interconnects/{interconnectId}/ip-pool: put: + tags: + - IP Pool summary: Update Existing Pool description: Modify the assigned IP Address blocks or the provider type for an existing Interconnect pool. This update occurs within the specific Interconnect @@ -487,29 +259,29 @@ paths: edge location mappings. You must submit the full updated list of IP Address blocks, specifying their primary or secondary status and the designated edge location. - operationId: PutMtSp-interconnectInterconnectsBy_interconnectidIp-pool - responses: - '200': - description: Success - '500': - description: Internal Error - '400': - description: Bad Request parameters: - name: interconnectId in: path required: true schema: type: string - tags: - - IP Pool requestBody: content: application/json: schema: $ref: '#/components/schemas/IPPoolRequest' required: true + responses: + '200': + description: Success + '500': + description: Internal Error + '400': + description: Bad Request + operationId: PutMtSp-interconnectInterconnectsBy_interconnectidIp-pool get: + tags: + - IP Pool summary: Get IP Address Address Pool description: View the current IP Address address configuration assigned to an Interconnect, including CIDR ranges and provider status. This provides visibility @@ -517,21 +289,21 @@ paths: to verify that the correct SP-provided or public IP Address ranges are in effect. The data returned includes the IP Address pool ID, its provisioning state, and a list of all active CIDR blocks. - operationId: GetMtSp-interconnectInterconnectsBy_interconnectidIp-pool - responses: - '200': - description: Success - '400': - description: Bad Request parameters: - name: interconnectId in: path required: true schema: type: string + responses: + '200': + description: Success + '400': + description: Bad Request + operationId: GetMtSp-interconnectInterconnectsBy_interconnectidIp-pool + delete: tags: - IP Pool - delete: summary: Delete IP Address Pool description: Remove all IP Address block associations and provider settings from the specified Interconnect. Terminating the pool stops the use of specific @@ -539,19 +311,19 @@ paths: when retiring BYOIP ranges or preparing to swap service provider IP Address schemes. Note that deleting an active pool will immediately impact egress traffic relying on those addresses. - operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidIp-pool - responses: - '200': - description: Success parameters: - name: interconnectId in: path required: true schema: type: string + responses: + '200': + description: Success + operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidIp-pool + post: tags: - IP Pool - post: summary: Create New Pool description: Provision and attach a new IP Address address pool to an existing Interconnect. This defines the addressing model (SP-provided or PANW-provided) @@ -559,37 +331,42 @@ paths: the egress setup for a new regional Interconnect container. When using SP-provided pools, you must include at least one valid public CIDR block mapped to a supported edge location. - operationId: PostMtSp-interconnectInterconnectsBy_interconnectidIp-pool - responses: - '201': - description: Success - '400': - description: Bad Request - '500': - description: Internal Error parameters: - name: interconnectId in: path required: true schema: type: string - tags: - - IP Pool requestBody: content: application/json: schema: $ref: '#/components/schemas/IPPoolRequest' required: true + responses: + '201': + description: Success + '400': + description: Bad Request + '500': + description: Internal Error + operationId: PostMtSp-interconnectInterconnectsBy_interconnectidIp-pool /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments: get: + tags: + - Vlan Attachment summary: List Vlan Attachments description: Retrieve all virtual circuits configured within a specific Interconnect. This allows administrators to verify the regional distribution of attachments and their current BGP states. Use this when auditing high-availability (HA) domains or verifying pairing key availability. The response lists BGP parameters, edge availability domains, and current provisioning states for each circuit. - operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachments + parameters: + - name: interconnectId + in: path + required: true + schema: + type: string responses: '200': description: Success @@ -597,15 +374,10 @@ paths: description: Bad Request '500': description: Server Error - parameters: - - name: interconnectId - in: path - required: true - schema: - type: string + operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachments + post: tags: - Vlan Attachment - post: summary: Provision Vlan Attachment description: Create a new virtual circuit, known as a VlanAttachment, within an Interconnect to enable data transfer. This establishes the actual logical @@ -613,32 +385,32 @@ paths: this when initializing new egress paths or adding redundant links for regional reliability. Required parameters include a unique name, BGP Peer ASN, and BFD initialization mode to ensure robust connectivity. - operationId: PostMtSp-interconnectInterconnectsBy_interconnectidVlan-attachments - responses: - '201': - description: Success - '404': - description: Not Found - '400': - description: Bad Request - '500': - description: Server Error parameters: - name: interconnectId in: path required: true schema: type: string - tags: - - Vlan Attachment requestBody: content: application/json: schema: $ref: '#/components/schemas/VlanAttachmentRequest' required: true + responses: + '201': + description: Success + '404': + description: Not Found + '400': + description: Bad Request + '500': + description: Server Error + operationId: PostMtSp-interconnectInterconnectsBy_interconnectidVlan-attachments /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}: get: + tags: + - Vlan Attachment summary: Get Vlan Attachment description: View the full technical specification of a single virtual circuit by its unique identifier. This displays parameters such as MD5 authentication, @@ -646,14 +418,6 @@ paths: key generation or to inspect the specific edge availability domain assigned for redundancy. The returned data provides the exact state needed for alignment with service provider configurations. - operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsbyvlanattachmentid - responses: - '200': - description: Success - '400': - description: Bad Request - '500': - description: Server Error parameters: - name: interconnectId in: path @@ -665,25 +429,23 @@ paths: required: true schema: type: string + responses: + '200': + description: Success + '400': + description: Bad Request + '500': + description: Server Error + operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentid + delete: tags: - Vlan Attachment - delete: summary: Delete Vlan Attachment description: Permanently remove a specific virtual circuit and its logical configuration from the Interconnect. Terminating these circuits is necessary when network paths are being replaced or retired. Execute this during scheduled maintenance windows or regional re-architecting. Ensure the paired service provider resource is also manually decommissioned to prevent unintended billing. - operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsbyvlanattachmentid - responses: - '200': - description: Success - '404': - description: Not Found - '400': - description: Bad Request - '500': - description: Server Error parameters: - name: interconnectId in: path @@ -695,26 +457,26 @@ paths: required: true schema: type: string - tags: - - Vlan Attachment + responses: + '200': + description: Success + '404': + description: Not Found + '400': + description: Bad Request + '500': + description: Server Error + operationId: DeleteMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentid /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/accept: post: + tags: + - Vlan Attachment summary: Accept AWS Attachment description: Transition a pending AWS Direct Connect attachment into the accepted state within the management plane. This serves as the final confirmation required by AWS to activate the virtual circuit. Trigger this action when the circuit state reaches PENDING_SP_ACCEPTANCE in the AWS console. Note that this action is exclusive to AWS deployments and cannot be used for GCP or other providers. - operationId: PostMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentidAccept - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Not Found - '500': - description: Server Error parameters: - name: interconnectId in: path @@ -726,10 +488,20 @@ paths: required: true schema: type: string - tags: - - Vlan Attachment + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Not Found + '500': + description: Server Error + operationId: PostMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentidAccept /mt/sp-interconnect/interconnects/{interconnectId}/vlan-attachments/{vlanAttachmentId}/logs: get: + tags: + - Vlan Attachment summary: Fetch Router Logs description: Retrieve real-time CloudRouter logs for virtual attachments deployed on the GCP network. These logs provide critical data on BGP session stability, @@ -737,14 +509,6 @@ paths: or when troubleshooting regional connectivity drops. You must provide a valid lookback duration (e.g., 1h, 1d); this feature is not supported for AWS-based attachments. - operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentidLogs - responses: - '200': - description: Success - '400': - description: Bad Request - '500': - description: Server Error parameters: - name: interconnectId in: path @@ -767,10 +531,18 @@ paths: - 1h - 1d - 3d - tags: - - Vlan Attachment + responses: + '200': + description: Success + '400': + description: Bad Request + '500': + description: Server Error + operationId: GetMtSp-interconnectInterconnectsBy_interconnectidVlan-attachmentsBy_vlanattachmentidLogs /mt/sp-interconnect/regions: get: + tags: + - Interconnect summary: List of Regions and Edge Locations description: Fetch the master list of all geographical regions and edge locations supported by the SP Interconnect service. This assists in network planning @@ -778,19 +550,19 @@ paths: data to determine the closest edge location to your physical infrastructure for low-latency traffic egress. The response is dynamically filtered based on the cloudProvider to ensure regional compatibility. - operationId: GetMtSp-interconnectRegions - responses: - '200': - description: Success parameters: - name: cloudProvider in: query schema: $ref: '#/components/schemas/CloudProvider' - tags: - - Interconnect + responses: + '200': + description: Success + operationId: GetMtSp-interconnectRegions /mt/sp-interconnect/regions/physical-connections: get: + tags: + - Interconnect summary: List of Physical Connection Regions in GCP description: Retrieve the specific regions and colocation facilities available for physical interconnect deployments on the GCP network. This informs network @@ -798,15 +570,14 @@ paths: provisioned. Use this when developing a dedicated physical connectivity strategy for large-scale multi-tenant environments. The data provides a hierarchy of continents, cities, and specific facility names. - operationId: GetMtSp-interconnectRegionsPhysical-connections responses: '200': description: Success - parameters: [] - tags: - - Interconnect + operationId: GetMtSp-interconnectRegionsPhysical-connections /mt/sp-interconnect/settings: post: + tags: + - Interconnect summary: Configure Egress Settings description: Apply traffic routing preferences and egress behavior for a specific Tenant Service Group (TSG). This determines whether egress traffic utilizes @@ -814,7 +585,12 @@ paths: path. Set this during tenant onboarding or when modifying existing regional traffic policies. If SP egress is selected, you must specify the CIDR ranges that should participate in the private routing. - operationId: PostMtSp-interconnectSettings + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SettingsEntry' + required: true responses: '200': description: Success @@ -822,16 +598,10 @@ paths: description: Bad Request '409': description: Conflict - parameters: [] + operationId: PostMtSp-interconnectSettings + get: tags: - Interconnect - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SettingsEntry' - required: true - get: summary: Get Egress Settings description: View the current egress and routing configuration for the authenticated tenant context. This verifies whether the tenant is currently utilizing the @@ -839,7 +609,6 @@ paths: this to validate that your network architecture policies have been correctly applied at the management plane. The response provides the egress type and all participating CIDR blocks. - operationId: GetMtSp-interconnectSettings responses: '200': description: Success @@ -847,6 +616,228 @@ paths: description: Bad Request '404': description: Not Found - parameters: [] - tags: - - Interconnect + operationId: GetMtSp-interconnectSettings +servers: +- url: https://api.sase.paloaltonetworks.com +security: +- authKey: [] +components: + schemas: + CloudProvider: + type: string + enum: + - GCP + - AWS + ConnectionType: + type: string + enum: + - DEDICATED + - PARTNER + DedicatedVlanAttachmentDetailsEntry: + type: object + properties: + edgeAvailability: + type: string + bandwidth: + $ref: '#/components/schemas/Bandwidth' + required: + - edgeAvailability + InterconnectRequest: + type: object + required: + - name + - region + - partnerName + - partnerEmail + - usage + - cloudProvider + - type + properties: + name: + type: string + pattern: ^([-0-9a-z]){1,13}$ + region: + type: string + pattern: \\S+ + partnerName: + type: string + pattern: ^([a-zA-Z0-9\s\-]){1,30}$ + partnerEmail: + type: string + pattern: \\S + usage: + $ref: '#/components/schemas/InterconnectUsage' + tsgId: + type: string + pattern: ^[0-9-]+$ + cloudProvider: + $ref: '#/components/schemas/CloudProvider' + type: + $ref: '#/components/schemas/ConnectionType' + ipPool: + $ref: '#/components/schemas/IPPoolRequest' + physicalConnection: + $ref: '#/components/schemas/PhysicalConnectionEntry' + vlanAttachment: + $ref: '#/components/schemas/VlanAttachmentRequest' + InterconnectUsage: + type: string + enum: + - SHARED + - PER_TENANT + IPPoolRequest: + type: object + required: + - ipProvider + properties: + ipBlocks: + type: array + uniqueItems: true + items: + $ref: '#/components/schemas/IPBlockEntry' + ipProvider: + $ref: '#/components/schemas/IPProvider' + IPBlockEntry: + type: object + required: + - cidr + properties: + edgeLocation: + type: string + cidr: + type: array + minItems: 1 + uniqueItems: true + items: + type: string + type: + $ref: '#/components/schemas/IPBlockType' + IPBlockType: + type: string + enum: + - PRIMARY + - SECONDARY + IPProvider: + type: string + enum: + - SP + - PANW + PhysicalConnectionEntry: + type: object + required: + - physicalConnectionName + - linkType + - coloFacilities + - partnerName + - partnerEmail + properties: + physicalConnectionName: + type: string + pattern: \\S + linkType: + $ref: '#/components/schemas/PhysicalInterconnectLinkType' + requestedLinkCount: + type: integer + format: int32 + coloFacilities: + type: array + minItems: 1 + items: + type: string + macSecEnabled: + type: boolean + partnerName: + type: string + pattern: \\S + partnerEmail: + type: string + pattern: \\S + PhysicalInterconnectLinkType: + type: string + enum: + - LINK_TYPE_ETHERNET_10G_LR + - LINK_TYPE_ETHERNET_100G_LR + VlanAttachmentRequest: + type: object + required: + - name + - bgpPeerAsn + - bgpPeerBfdSessionInitMode + properties: + name: + type: string + pattern: ^([-0-9a-z]){1,13}$ + stackType: + $ref: '#/components/schemas/StackType' + bandwidth: + $ref: '#/components/schemas/Bandwidth' + bgpPeerAsn: + type: integer + format: int64 + minimum: 1 + bgpPeerBfdSessionInitMode: + $ref: '#/components/schemas/SessionInitializationMode' + bgpPeerBfdMinTransmitInterval: + type: integer + format: int64 + maximum: 30000 + minimum: 1000 + bgpPeerBfdMinReceiveInterval: + type: integer + format: int64 + maximum: 30000 + minimum: 1000 + bgpPeerBfdMultiplier: + type: integer + format: int64 + maximum: 16 + minimum: 5 + dedicatedConnectionDetails: + type: array + items: + $ref: '#/components/schemas/DedicatedVlanAttachmentDetailsEntry' + bgpPeerMd5AuthEnabled: + type: boolean + StackType: + type: string + enum: + - IPV4_ONLY + - IPV4_IPV6 + Bandwidth: + type: string + enum: + - BPS_50M + - BPS_100M + - BPS_200M + - BPS_300M + - BPS_400M + - BPS_500M + - BPS_1G + - BPS_2G + - BPS_5G + - BPS_10G + SessionInitializationMode: + type: string + enum: + - ACTIVE + - PASSIVE + - DISABLED + SettingsEntry: + type: object + required: + - egressType + properties: + egressType: + type: string + pattern: SP|PA + cidr: + type: array + uniqueItems: true + items: + type: string + pattern: ^((25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})(\.(25[0-5]|2[0-4][0-9]|[0-1]?[0-9]{1,2})){3})/(3[0-2]|[1-2][0-9]|[0-9])$ + securitySchemes: + authKey: + type: http + scheme: Bearer +ExternalTags: {} diff --git a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml index edcd5eb13..1ea675e52 100644 --- a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml +++ b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml @@ -1,6 +1,6 @@ openapi: 3.1.0 info: - title: SP Interconnect Manage APIs + title: SP Interconnect APIs version: '1.0' description: "These APIs deliver real-time visibility and performance analytics\ \ for all configured interconnect \nresources through the monitoring plane. They\ @@ -9,24 +9,13 @@ info: \ these metrics during routine audits or active troubleshooting to diagnose latency\ \ spikes or BGP session instability. \nBy applying time-based filters and histograms,\ \ you can generate detailed traffic trends and monitor IP pool consumption across\ - \ your global infrastructure. This Open API spec file was created on February\ - \ 04, 2026. \xA9 2026 Palo Alto Networks, Inc. Palo Alto Networks is a registered\ - \ trademark of Palo Alto Networks. A list of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\ - \ All other marks mentioned herein may be trademarks of their respective companies." -servers: -- url: https://api.sase.paloaltonetworks.com -security: -- BearerAuth: [] -components: - securitySchemes: - BearerAuth: - type: http - scheme: bearer - bearerFormat: JWT -ExternalTags: {} + \ your global infrastructure. Created on February 04, 2026. \xA9 2026 Palo Alto\ + \ Networks, Inc." paths: /mt/sp-interconnect/monitor/vlanAttachments/stats: post: + tags: + - VLAN Attachment Statistics summary: Get Vlan Attachment Statistics description: "Retrieve granular performance metrics and operational metadata\ \ for virtual circuits within the multi-tenant interconnect framework. This\ @@ -36,19 +25,6 @@ paths: \ with actual consumption. To execute, define the desired properties\u2014\ such as ingress/egress throughput or cloud router IPs\u2014and apply filters\ \ based on time ranges or specific interconnect IDs." - operationId: PostMtSp-interconnectMonitorVlanattachmentsStats - responses: - '200': - description: Success - '400': - description: Bad Request - '401': - description: Permission Denied - '500': - description: Server Error - parameters: [] - tags: - - VLAN Attachment Statistics requestBody: content: application/json: @@ -73,8 +49,20 @@ paths: operator: in values: - c4ac1cc9-684e-11f0-92e9-4201ac16024e + responses: + '200': + description: Success + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtSp-interconnectMonitorVlanattachmentsStats /mt/sp-interconnect/monitor/interconnects/traffic: post: + tags: + - Interconnect Traffic summary: Get Interconnect Data Transfer description: Aggregate data transfer volumes for entire Interconnect containers to track total network consumption. This information is calculated at the @@ -84,24 +72,12 @@ paths: You can retrieve either specific windowed data or total lifetime traffic by toggling the lifetime query parameter and defining the appropriate time-based filters. - operationId: PostMtSp-interconnectMonitorInterconnectsTraffic - responses: - '200': - description: Success - '400': - description: Bad Request - '401': - description: Permission Denied - '500': - description: Server Error parameters: - name: lifetime in: query schema: type: boolean description: Set to true to get lifetime traffic data - tags: - - Interconnect Traffic requestBody: content: application/json: @@ -125,17 +101,6 @@ paths: operator: equals values: - c4ac1d7a-684e-11f0-92e9-4201ac16024e - /mt/sp-interconnect/monitor/interconnects/throughput: - post: - summary: Get Throughput By Interconnect - description: Monitor the real-time and historical throughput rates for designated - Interconnect resources. This metric tracks the speed of data flow across the - Service Provider bridge to identify potential bottlenecks or underutilized - capacity. Access this when performing performance tuning or when investigating - regional latency issues. To proceed, define the throughput properties and - use the histogram object to group data by time intervals, such as daily or - hourly trends. - operationId: PostMtSp-interconnectMonitorInterconnectsThroughput responses: '200': description: Success @@ -145,9 +110,19 @@ paths: description: Permission Denied '500': description: Server Error - parameters: [] + operationId: PostMtSp-interconnectMonitorInterconnectsTraffic + /mt/sp-interconnect/monitor/interconnects/throughput: + post: tags: - Interconnect Throughput + summary: Get Throughput By Interconnect + description: Monitor the real-time and historical throughput rates for designated + Interconnect resources. This metric tracks the speed of data flow across the + Service Provider bridge to identify potential bottlenecks or underutilized + capacity. Access this when performing performance tuning or when investigating + regional latency issues. To proceed, define the throughput properties and + use the histogram object to group data by time intervals, such as daily or + hourly trends. requestBody: content: application/json: @@ -173,17 +148,6 @@ paths: range: day enableEmptyInterval: false value: '1' - /mt/sp-interconnect/monitor/vlanAttachments/throughput: - post: - summary: Get Vlan Attachment Throughput Trends - description: Track throughput performance specifically for individual virtual - circuits within an Interconnect. This provides granular visibility into the - load distribution across multiple VlanAttachments to ensure high-availability - (HA) domains are operating as expected. Use this when diagnosing specific - circuit failures or verifying that a new attachment is carrying traffic correctly. - Define the VlanAttachment ID and apply a time-based histogram to visualize - throughput shifts over the desired monitoring period. - operationId: PostMtSp-interconnectMonitorVlanattachmentsThroughput responses: '200': description: Success @@ -193,9 +157,19 @@ paths: description: Permission Denied '500': description: Server Error - parameters: [] + operationId: PostMtSp-interconnectMonitorInterconnectsThroughput + /mt/sp-interconnect/monitor/vlanAttachments/throughput: + post: tags: - VLAN Attachment Throughput + summary: Get Vlan Attachment Throughput Trends + description: Track throughput performance specifically for individual virtual + circuits within an Interconnect. This provides granular visibility into the + load distribution across multiple VlanAttachments to ensure high-availability + (HA) domains are operating as expected. Use this when diagnosing specific + circuit failures or verifying that a new attachment is carrying traffic correctly. + Define the VlanAttachment ID and apply a time-based histogram to visualize + throughput shifts over the desired monitoring period. requestBody: content: application/json: @@ -222,17 +196,6 @@ paths: range: day enableEmptyInterval: false value: '1' - /mt/sp-interconnect/monitor/vlanAttachments/traffic: - post: - summary: Get Vlan Attachment Traffic Trends - description: Analyze traffic volume trends for specific virtual circuits over - time. This function captures the total amount of data processed by a VlanAttachment, - assisting in usage-based auditing or capacity forecasting for regional egress. - Deploy this when identifying which virtual circuits are the primary contributors - to regional data transfer. Provide the unique circuit identifier and specify - the aggregation function, such as a sum of egress traffic, to generate a time-series - traffic report. - operationId: PostMtSp-interconnectMonitorVlanattachmentsTraffic responses: '200': description: Success @@ -242,9 +205,19 @@ paths: description: Permission Denied '500': description: Server Error - parameters: [] + operationId: PostMtSp-interconnectMonitorVlanattachmentsThroughput + /mt/sp-interconnect/monitor/vlanAttachments/traffic: + post: tags: - VLAN Attachment Traffic + summary: Get Vlan Attachment Traffic Trends + description: Analyze traffic volume trends for specific virtual circuits over + time. This function captures the total amount of data processed by a VlanAttachment, + assisting in usage-based auditing or capacity forecasting for regional egress. + Deploy this when identifying which virtual circuits are the primary contributors + to regional data transfer. Provide the unique circuit identifier and specify + the aggregation function, such as a sum of egress traffic, to generate a time-series + traffic report. requestBody: content: application/json: @@ -271,17 +244,6 @@ paths: range: day enableEmptyInterval: false value: '1' - /mt/sp-interconnect/monitor/vlanAttachments/latency: - post: - summary: Get Vlan Attachment Latency Trends - description: Monitor latency performance for virtual circuits to ensure network - paths meet required service levels. This metric measures the delay in traffic - traversal between Prisma Access and the Service Provider edge. Access this - during troubleshooting to determine if network slowness is related to the - private Interconnect path rather than internal cloud routing. Specify the - vlan_attachment_id and utilize a daily or hourly histogram to detect latency - spikes or persistent high-delay trends. - operationId: PostMtSp-interconnectMonitorVlanattachmentsLatency responses: '200': description: Success @@ -291,9 +253,19 @@ paths: description: Permission Denied '500': description: Server Error - parameters: [] + operationId: PostMtSp-interconnectMonitorVlanattachmentsTraffic + /mt/sp-interconnect/monitor/vlanAttachments/latency: + post: tags: - VLAN Attachment Latency + summary: Get Vlan Attachment Latency Trends + description: Monitor latency performance for virtual circuits to ensure network + paths meet required service levels. This metric measures the delay in traffic + traversal between Prisma Access and the Service Provider edge. Access this + during troubleshooting to determine if network slowness is related to the + private Interconnect path rather than internal cloud routing. Specify the + vlan_attachment_id and utilize a daily or hourly histogram to detect latency + spikes or persistent high-delay trends. requestBody: content: application/json: @@ -318,8 +290,20 @@ paths: range: day enableEmptyInterval: false value: '1' + responses: + '200': + description: Success + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtSp-interconnectMonitorVlanattachmentsLatency /mt/sp-interconnect/monitor/ip-pool-usage: get: + tags: + - IP Pool Usage summary: Get IP Address Pool Usage description: Retrieve consumption statistics for the IP Address address pools assigned to an Interconnect. This visibility helps prevent IP Address exhaustion @@ -328,7 +312,14 @@ paths: or when investigating incidents related to IP Address address unavailability. By submitting a valid interconnectId, you receive data on used IPs, incident counts, and pool locations for the specified resource. - operationId: GetMtSp-interconnectMonitorIp-pool-usage + parameters: + - name: interconnectId + in: query + required: true + schema: + type: string + description: The interconnect ID to query + example: c4ac1d7a-684e-11f0-92e9-4201ac16024e responses: '200': description: Success @@ -338,13 +329,15 @@ paths: description: Permission Denied '500': description: Server Error - parameters: - - name: interconnectId - in: query - required: true - schema: - type: string - description: The interconnect ID to query - example: c4ac1d7a-684e-11f0-92e9-4201ac16024e - tags: - - IP Pool Usage + operationId: GetMtSp-interconnectMonitorIp-pool-usage +servers: +- url: https://api.sase.paloaltonetworks.com +security: +- BearerAuth: [] +components: + securitySchemes: + BearerAuth: + type: http + scheme: bearer + bearerFormat: JWT +ExternalTags: {} From 4414fab37faaa63470a9caf8fd425af709a004e5 Mon Sep 17 00:00:00 2001 From: sra Date: Fri, 6 Feb 2026 22:40:09 +0530 Subject: [PATCH 8/9] DOCS-8900 Added 5G Monitor and updated 5G Manage API along with SP Interconnect Manage and Monitor --- docusaurus.config.ts | 12 +- ...gement Service.yaml => 5G-Manage-new.yaml} | 1990 +++++++++-------- .../sase/monitor-services-5g/5G-monitor.yaml | 997 +++++++++ .../api/manage-services-5g/introduction.md | 3 +- .../sase/api/manage-services-5g/overview.md | 2 +- .../introduction_monitor.md | 16 + products/sase/sidebars.ts | 8 +- 7 files changed, 2095 insertions(+), 933 deletions(-) rename openapi-specs/sase/manage-services-5g/{5G Management Service.yaml => 5G-Manage-new.yaml} (64%) create mode 100644 openapi-specs/sase/monitor-services-5g/5G-monitor.yaml create mode 100644 products/sase/api/monitor-services-5g/introduction_monitor.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts index fee318279..80a9fecd8 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -494,10 +494,15 @@ const config = { icon: "api-doc", }, { - to: "sase/api/manage-services-5g", + to: "sase/api/manage-services-5g/introduction", label: "SASE 5G Manage Services", icon: "api-doc", }, + { + to: "sase/api/monitor-services-5g/introduction_monitor", + label: "SASE 5G Monitor Services", + icon: "api-doc", + }, { to: "/sase/api/introduction", label: "Prisma Access Configuration Orchestration", @@ -936,6 +941,11 @@ const config = { outputDir: "products/sase/api/manage-services-5g", sidebarOptions: { groupPathsBy: "tag" }, }, + monitorservices: { + specPath: "openapi-specs/sase/monitor-services-5g", + outputDir: "products/sase/api/monitor-services-5g", + sidebarOptions: { groupPathsBy: "tag" }, + }, configorch: { specPath: "openapi-specs/sase/config-orch", outputDir: "products/sase/api/config-orch", diff --git a/openapi-specs/sase/manage-services-5g/5G Management Service.yaml b/openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml similarity index 64% rename from openapi-specs/sase/manage-services-5g/5G Management Service.yaml rename to openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml index dda9515b2..65a321097 100644 --- a/openapi-specs/sase/manage-services-5g/5G Management Service.yaml +++ b/openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml @@ -1,161 +1,7 @@ -components: - schemas: - CieTokenRequest: - properties: - access_token: - type: string - cie_directory: - type: string - created_at: - type: string - created_by: - type: string - tsg_id: - type: string - type: object - JsonObject: - items: - type: string - type: array - RadiusProxyRequest: - properties: - ipaddress: - type: string - name: - type: string - type: object - RadiusServerSecretRequest: - properties: - created_by: - type: string - secret: - type: string - type: object - RegisterUE: - description: A list of one or more UEs - items: - properties: - apn: - description: APN (Access Point Name) for the Tenant UE - example: apn@panw.com - type: string - cellId: - type: string - eventTime: - description: epoc time in ms - type: integer - expiryTime: - description: epoc time in ms - type: integer - imei: - description: 15 digit IMEI (International Mobile Equipment Identity) number. - Error is returned if number of digits is not exactly 15.Last digit will - be replaced by zero. - example: '123456789012345' - type: string - imsi: - description: 15 digit IMSI (International Mobile Subscriber Identity) - number. Error is returned if number of digits is not exactly 15. - example: '123456789012345' - type: string - ipType: - description: it tells whether it is ipv4, ipv6 or dual stack. Valid values - are IPv4, IPv6, IPv4v6 - example: IPV4 - type: string - ipv4Addr: - type: string - ipv6Addr: - type: string - msisdn: - type: string - ratType: - type: string - sliceId: - type: string - supi: - type: string - required: - - eventTime - - ipType - - imsi - - imei - - apn - type: object - type: array - SetInterface: - properties: - interfaceType: - example: RADIUS - type: string - interimMsgInterval: - description: How often interim messages will come(in minutes) - type: integer - processInterimMsg: - default: false - type: boolean - required: - - interfaceType - type: object - TenantGroupInfo: - properties: - group_name: - type: string - identity_id: - items: - type: string - type: array - tsg_id: - type: string - type: object - TenantGroupInfoListInput: - properties: - group_id: - type: string - tsg_id: - type: string - type: object - TenantUEInfoListInput: - properties: - tsg_id: - type: string - type: object - TenantUEInfoRequest: - properties: - apn: - type: string - imei: - type: string - imsi: - type: string - root_tsg_id: - type: string - tsg_id: - type: string - type: object - TenantUeInfoBulkDeleteRequest: - properties: - identityIds: - items: - type: string - type: array - type: object - UpdateInterimMsg: - properties: - interval: - description: How often interim messages will come(in minutes) - type: integer - processMsg: - default: false - type: boolean - type: object - securitySchemes: - Bearer: - scheme: bearer - type: http +openapi: 3.0.2 info: - contact: - email: support@paloaltonetworks.com + title: SASE 5G Manage API + version: '1.0' description: "The evolution of 5G technology is transforming enterprise connectivity,\ \ offering unprecedented speed and capacity. \nAs businesses embrace 5G networks,\ \ the demand for robust security measures grows exponentially. \nService Providers\ @@ -169,25 +15,19 @@ info: \ - one that combines scalability, ease of management, \nand comprehensive protection\ \ across all 5G scenarios. \nThe Enterprise 5G Security Solution emerges as the\ \ answer to these pressing needs, \noffering a new approach to securing the future\ - \ of enterprise connectivity.\n\nThese APIs use the common SASE authentication\ - \ mechanism and base URL. See the\n[Prisma SASE API Get Started](https://pan.dev/sase/docs/getstarted)\ - \ guide for more information.\n\nThis Open API spec file was created on October\ - \ 07, 2025. To check for a more recent version of this file, see\n[SASE 5G Manage\ - \ Services APIs on pan.dev](https://pan.dev/sase/api/manage-services-5g/introduction).\n\ - \n\xA9 2025 Palo Alto Networks, Inc. Palo Alto Networks is a registered trademark\ - \ of Palo\nAlto Networks. A list of our trademarks can be found at\n\n[https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html)\n\ - \nAll other marks mentioned herein may be trademarks of their respective companies.\n" - title: SASE 5G Manage Service APIs - version: '1.0' -openapi: 3.0.2 + \ of enterprise connectivity. This spec was created on February 06, 2026. \xA9\ + \ 2026 Palo Alto Networks, Inc." paths: /mt/manage/5g/cie/token: post: - description: 'Save the Customer Identity and Engagement (CIE) token for the - leaf tenant. This token is used for authentication and authorization purposes. - - ' - operationId: post-mt-manage-5g-cie-token + tags: + - Cie Token Resource API + summary: Save Tenant Token + description: Use this endpoint to store the Cloud Identity Engine (CIE) token + for a specific leaf tenant within the management plane. This action establishes + the necessary credentials required for cross-tenant identity synchronization. + Perform this step during initial tenant onboarding or whenever identity credentials + require a refresh to maintain secure directory access. requestBody: content: application/json: @@ -202,19 +42,17 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Save CIE token - tags: - - CIE Token Resource + operationId: PostMtManage5gCieToken /mt/manage/5g/cie/token/details: post: - description: 'Retrieve the details of the Customer Identity and Engagement (CIE) - token for the leaf tenant. This includes information about the token''s validity - and usage. - - ' - operationId: post-mt-manage-5g-cie-token-details + tags: + - Cie Token Resource API + summary: Get Token Details + description: Administrators can retrieve technical metadata for a leaf tenant's + Cloud Identity Engine (CIE) token through this interface. The system accesses + the secure storage vault to verify token validity and expiration status. Utilize + this query when auditing tenant connectivity or troubleshooting identity-based + access failures to ensure the synchronization service remains operational. requestBody: content: application/json: @@ -229,48 +67,53 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Get CIE token details - tags: - - CIE Token Resource - /mt/manage/5g/connection: + operationId: PostMtManage5gCieTokenDetails + /mt/manage/5g/interconnect: get: - description: 'Retrieve connection details by regions. This includes information - about the current status and configuration of connections in different regions. - - ' - operationId: get-mt-manage-5g-connection + tags: + - Interconnect API + summary: Get Interconnect Details + description: This endpoint retrieves comprehensive technical data for all configured + 5G Network Interconnects, organized by geographical region. The management + plane aggregates metrics such as bandwidth capacity, vlan attachment counts, + and current operational status. Review these details when planning regional + capacity expansions or monitoring the health of the physical-to-virtual infrastructure + bridge. responses: '200': + description: Success content: application/json: examples: - Get Connection Details by region: + Get Interconnect Details by region: value: data: - bandwidth: 500000000 computeRegion: us-west2 - connectionCount: 2 - connectionStatusEntry: + status: Supported + vlanAttachmentCount: 2 + vlanAttachmentStatusEntry: down: 1 up: 1 - bandwidth: 100000000 computeRegion: us-central1 - connectionCount: 1 - connectionStatusEntry: + status: Supported + vlanAttachmentCount: 1 + vlanAttachmentStatusEntry: down: 0 up: 1 - bandwidth: 400000000 computeRegion: us-east2 - connectionCount: 1 - connectionStatusEntry: + status: Supported + vlanAttachmentCount: 1 + vlanAttachmentStatusEntry: down: 0 up: 1 - bandwidth: 300000000 computeRegion: us-west1 - connectionCount: 1 - connectionStatusEntry: + status: Supported + vlanAttachmentCount: 1 + vlanAttachmentStatusEntry: down: 1 up: 0 header: @@ -278,109 +121,45 @@ paths: dataCount: 4 status: subCode: 200 - description: Success '400': description: Bad Request '404': description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Get connection details - tags: - - Connection + operationId: GetMtManage5gInterconnect /mt/manage/5g/control/cert/download: get: - description: 'Download the certificate file required to enable 5G connectivity - for a specified region. This certificate is used for secure communication. - - ' - operationId: get-mt-manage-5g-control-cert-download - responses: - '200': - description: Success - '400': - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Download certificate - tags: - - ControlPlane Resource - /mt/manage/5g/control/interface: - get: - description: 'Retrieve details of the interface currently selected by the user. - - ' - operationId: get-mt-manage-5g-control-interface - responses: - '200': - description: Successful response - '500': - description: Server Error - security: - - Bearer: [] - summary: Get Interface - tags: - - ControlPlane Resource - post: - description: 'Set the interface type. You can optionally include interim message - configuration in the request. - - ' - operationId: post-mt-manage-5g-control-interface - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetInterface' - responses: - '200': - description: Successful response - '400': - description: Bad Request - '500': - description: Server Error - security: - - Bearer: [] - summary: Add Interface tags: - - ControlPlane Resource - /mt/manage/5g/control/interimMsg: - put: - description: This api allows you to update the interim message config - operationId: put-mt-manage-5g-control-interimmsg - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateInterimMsg' + - Control Plane Resource API + summary: Download Certificate File + description: Securely download the required 5G control plane certificate to + establish encrypted communication between local infrastructure and the Prisma + Access backbone. This file contains the cryptographic keys needed to authorize + 5G connectivity within a specific management region. Execute this download + during the initial site setup phase to finalize the secure tunnel configuration + for 5G traffic. responses: '200': - description: Successful response + description: Success '400': description: Bad Request '404': description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Update the Interim Message Configuration - tags: - - ControlPlane Resource + operationId: GetMtManage5gControlCertDownload /mt/manage/5g/control/proxycert: get: - description: 'Check if the client certificate is uploaded for the root tenant - security group (root tsg). This certificate is necessary for secure proxy - communication. - - ' - operationId: get-mt-manage-5g-control-proxycert + tags: + - Control Plane Resource API + summary: Verify Proxy Certificate + description: Query the management plane to confirm whether the required proxy + certificate has been successfully uploaded for the root Tenant Service Group + (TSG). This check ensures that the administrative hierarchy has the valid + credentials necessary for high-level traffic inspection. Use this verification + step before attempting to provision child tenants or deploying 5G-enabled + security policies. responses: '200': description: Success @@ -390,36 +169,36 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Get Client Certificate - tags: - - ControlPlane Resource + operationId: GetMtManage5gControlProxycert /mt/manage/5g/control/proxycert/upload: post: - description: 'Upload the client certificate to enable 5G connectivity for a - specified region. This certificate is necessary for secure proxy communication. - - ' - operationId: post-mt-manage-5g-control-proxycert-upload + tags: + - Control Plane Resource API + summary: Upload Certificate File + description: Transmit the cryptographic proxy certificate to the root Tenant + Service Group (TSG) to enable secure traffic handling within the 5G management + plane. By providing the binary file and associated TSG identifiers, administrators + establish the trust anchor required for secure communication. Perform this + upload when initializing a new 5G region or updating expired certificates + to prevent service interruptions. requestBody: content: multipart/form-data: - encoding: - file: - contentType: application/octet-stream schema: + type: object properties: file: format: binary type: string filename: type: string - rootTsgId: - type: string tsgId: type: string - type: object + rootTsgId: + type: string + encoding: + file: + contentType: application/octet-stream responses: '200': description: Success @@ -429,19 +208,16 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Upload Client certificate - tags: - - ControlPlane Resource + operationId: PostMtManage5gControlProxycertUpload /mt/manage/5g/control/radiusProxy: get: - description: 'Retrieve the shared secret for the RADIUS server associated with - the root tenant security group (root tsg). This secret is used for secure - RADIUS communication. - - ' - operationId: get-mt-manage-5g-control-radiusproxy + tags: + - Control Plane Resource API + summary: Get Radius Proxy + description: Fetch the RADIUS server shared secret assigned to the root Tenant + Service Group (TSG) for authentication audit purposes. This endpoint retrieves + the secret from secure storage to verify that the 5G management plane aligns + with existing RADIUS server configurations. responses: '200': description: Success @@ -451,14 +227,16 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Get RADIUS server secret - tags: - - ControlPlane Resource + operationId: GetMtManage5gControlRadiusproxy post: - description: Add radius server shared secrete forroot tsg - operationId: post-mt-manage-5g-control-radiusproxy + tags: + - Control Plane Resource API + summary: Add Radius Proxy + description: Create a new RADIUS server shared secret configuration for the + root Tenant Service Group (TSG). Administrators submit the specific secret + and creator details to enable the 5G management plane to proxy authentication + requests effectively. Initialize this configuration when adding new authentication + nodes or refreshing security keys for the 5G infrastructure. requestBody: content: application/json: @@ -473,19 +251,17 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Add radius server shared secrete for root tsg - tags: - - ControlPlane Resource + operationId: PostMtManage5gControlRadiusproxy /mt/manage/5g/control/radiusSecret: get: - description: 'Retrieve the shared secret for the RADIUS server associated with - the root tenant security group (root tsg). This secret is used for secure - RADIUS communication. - - ' - operationId: get-mt-manage-5g-control-radiussecret + tags: + - Control Plane Resource API + summary: Get Radius Secret + description: Fetch the shared secret key used for communicating with the external + RADIUS server in the root tenant context. This allows administrators to audit + the current security parameters used to authorize 5G subscriber sessions. + Access this information when validating that local authentication configurations + match the 5G management plane settings. responses: '200': description: Success @@ -495,14 +271,16 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Get RADIUS server secret - tags: - - ControlPlane Resource + operationId: GetMtManage5gControlRadiussecret post: - description: Add radius server shared secrete forroot tsg - operationId: post-mt-manage-5g-control-radiussecret + tags: + - Control Plane Resource API + summary: Add Radius Secret + description: Assign a new cryptographic shared secret for RADIUS server communication + within the root Tenant Service Group (TSG). Administrators use this to establish + the primary trust bond between the 5G management service and the corporate + identity directory. Perform this operation when configuring initial authentication + workflows or as part of a scheduled secret rotation policy. requestBody: content: application/json: @@ -517,18 +295,17 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Add radius server shared secrete for root tsg - tags: - - ControlPlane Resource + operationId: PostMtManage5gControlRadiussecret /mt/manage/5g/control/radiusServers: get: - description: 'Retrieve details of the RADIUS servers. This includes information - about the configuration and status of the RADIUS servers. - - ' - operationId: get-mt-manage-5g-control-radiusservers + tags: + - Control Plane Resource API + summary: Get Radius Details + description: Retrieve the full technical specifications and configuration status + of all active RADIUS servers within a specific management region. The system + returns server addresses and metadata required to maintain 5G connectivity + and authentication flows. Use this endpoint during network troubleshooting + or when auditing the external authentication dependencies of the 5G service. responses: '200': description: Success @@ -538,314 +315,233 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Get RADIUS server details - tags: - - ControlPlane Resource + operationId: GetMtManage5gControlRadiusservers /mt/manage/5g/control/supported/interfaces: get: - description: 'Retrieve all supported interface types available in the system. - - ' - operationId: get-mt-manage-5g-control-supported-interfaces + tags: + - Control Plane Resource API + summary: List Supported Interfaces + description: Access a comprehensive list of all data interfaces currently supported + by the 5G management service, such as RADIUS or Application Programming Interface-based + enrichment. This inventory identifies which integration methods are available + for tenant data processing. Consult this list when determining the optimal + telemetry integration strategy for a new 5G deployment. responses: '200': description: Successful response '500': description: Server Error - security: - - Bearer: [] - summary: List Supported Interfaces + operationId: GetMtManage5gControlSupportedInterfaces + /mt/manage/5g/control/interface: + get: tags: - - ControlPlane Resource - /mt/manage/5g/deregister/ue: + - Control Plane Resource API + summary: Get Interface Type + description: View the specific interface type currently selected for 5G telemetry + processing within the tenant context. This check identifies whether the system + uses active RADIUS polling or passive Application Programming Interface-based + registration for UE mapping. + responses: + '200': + description: Successful response + '500': + description: Server Error + operationId: GetMtManage5gControlInterface post: - description: 'Remove a previously registered User Equipment (UE) from the system. - - ' - operationId: post-mt-manage-5g-deregister-ue + tags: + - Control Plane Resource API + summary: Add Interface Type + description: "Define the primary interface type and interim message configuration\ + \ for the 5G control plane. Administrators set the integration model\u2014\ + such as RADIUS with optional message intervals\u2014to determine how the system\ + \ receives subscriber telemetry. Configure this when establishing the 5G connectivity\ + \ model to ensure accurate data synchronization." requestBody: content: application/json: - examples: - Degister Success: - value: - - apn: demo.com - eventTime: 123456789009 - imei: '333333333333333' - imsi: '333333333333333' - ipType: IPv4 - ipv4Addr: 172.29.0.8 schema: - $ref: '#/components/schemas/RegisterUE' + $ref: '#/components/schemas/SetInterface' responses: - '202': - content: - application/json: - examples: - Successful: - summary: Request Accepted - schema: - type: object - description: Accepted - '401': - content: - application/json: - example: - clientRequestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab - details: Interface set is not API - errorCode: '60076' - message: Either 5g is not enabled or interface is not API - requestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab - service: 5G Management Service - schema: - type: object - description: Unauthorized - security: - - Bearer: [] - summary: DeRegister UE + '200': + description: Successful response + '400': + description: Bad Request + '500': + description: Server Error + operationId: PostMtManage5gControlInterface + /mt/manage/5g/control/interimMsg: + put: tags: - - UE Enrichment - /mt/manage/5g/register/ue: - post: - description: 'Register a User Equipment (UE) with the system by submitting IMSI, - IMEI, APN, IP address, and event details. - - ' - operationId: post-mt-manage-5g-register-ue + - Control Plane Resource API + summary: Update Interim Configuration + description: Modify the existing interim message interval and processing status + for an active 5G control plane interface. This update allows administrators + to tune the frequency of heartbeat messages to optimize performance or increase + synchronization accuracy. Apply these changes when network conditions or telemetry + requirements shift during active operation. requestBody: content: application/json: - examples: - IP out of Range: - value: - - apn: demo.com - eventTime: 123456789009 - imei: '333333333333333' - imsi: '333333333333333' - ipType: IPv4 - ipv4Addr: 192.29.0.8 - Incorrect Payload: - value: - - apn: demo.com - eventTime: 123456789009 - imei: '333333333333333' - imsi: '3333333333333' - ipType: IPv4 - ipv4Addr: 172.29.0.8 - Missing mandory param: - value: - - apn: demo.com - imei: '333333333333333' - imsi: '333333333333333' - ipType: IPv4 - ipv4Addr: 172.29.0.8 - Partially correct payload: - value: - - apn: demo.com - eventTime: 123456789009 - expiryTime: 1234568988 - imei: '444444444444444' - imsi: '444444444444444' - ipType: IPv4 - ipv4Addr: 172.29.0.10 - - apn: demo.com - expiryTime: 1234568988 - imei: '333333333333444' - imsi: '333333333333444' - ipType: IPv4 - ipv4Addr: 172.29.0.9 - msisdn: test - Register UE With mandatory params: - value: - - apn: demo.com - eventTime: 123456789009 - imei: '333333333333333' - imsi: '333333333333333' - ipType: IPv4 - ipv4Addr: 172.29.0.8 - Update expiry Time: - value: - - apn: demo.com - eventTime: 123456789009 - expiryTime: 8765432190 - imei: '333333333333333' - imsi: '333333333333333' - ipType: IPv4 - ipv4Addr: 172.29.0.8 schema: - $ref: '#/components/schemas/RegisterUE' + $ref: '#/components/schemas/UpdateInterimMsg' responses: - '202': - content: - application/json: - examples: - Successful: - summary: Request Accepted - schema: - type: object - description: Accepted - '207': - content: - application/json: - example: - apn: demo.com - errorMsg: Event time is must - expiryTime: 1234568988 - imei: '333333333333440' - imsi: '333333333333444' - ipType: 0 - ipv4Addr: 172.29.0.9 - msisdn: test - schema: - type: object - description: Partial Success + '200': + description: Successful response '400': - content: - application/json: - examples: - example-0: - summary: Incorrect Payload - value: - apn: demo.com - errorMsg: IMSI needs to be 15 digits, current length is 13 - eventTime: 123456789009 - imei: '333333333333333' - imsi: '3333333333333' - ipType: 0 - ipv4Addr: 172.29.0.8 - example-1: - summary: IP Out of Range - value: - apn: demo.com - errorMsg: IP is not a part of any ue cidr block - eventTime: 123456789009 - imei: '333333333333330' - imsi: '333333333333333' - ipType: 0 - ipv4Addr: 192.29.0.8 - example-2: - summary: Missing mandatory param - value: - apn: demo.com - errorMsg: Event time is must - imei: '333333333333330' - imsi: '333333333333333' - ipType: 0 - ipv4Addr: 172.29.0.8 - schema: - type: object description: Bad Request - '401': - content: - application/json: - example: - clientRequestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab - details: Interface set is not API - errorCode: '60076' - message: Either 5g is not enabled or interface is not API - requestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab - service: 5G Management Service - schema: - type: object - description: Unauthorized - security: - - Bearer: [] - summary: Register UE + '404': + description: Data Not Found + '500': + description: Server Error + operationId: PutMtManage5gControlInterimmsg + /mt/manage/5g/ipcidr/{compute_region}: + get: tags: - - UE Enrichment + - Enable 5 GAPI + summary: Get IP Address Cidr + description: Retrieve the allocated IPv4 and IPv6 CIDR blocks for the 5G User + Equipment (UE) pool within a specific compute region. The management plane + provides these ranges to identify which IP Address sets are reserved for secure + 5G traffic. Access this information when configuring firewall rules or verifying + IP Address resource availability for regional 5G deployments. + parameters: + - name: compute_region + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + operationId: GetMtManage5gIpcidrBy_compute_region + /mt/manage/5g/setup: + post: + tags: + - Enable 5 GAPI + summary: Enable 5G Connectivity + description: Initialize the 5G connectivity framework for a specific compute + region by provisioning the necessary CIDR blocks and enabling the management + plane. Administrators submit the desired region and IP Address ranges to establish + the secure tunnel between the 5G provider and the Prisma Access backbone. + Use this endpoint once during the initial setup of a new 5G-capable service + region. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Enable5GRequest' + responses: + '200': + description: Success + '400': + description: Bad Request + '404': + description: Data Not Found + '500': + description: Server Error + operationId: PostMtManage5gSetup /mt/manage/5g/tenantUEInfo: post: - description: 'Create tenant-user equipment (UE) information. This includes mapping - user devices to tenants for management and policy enforcement. - - ' - operationId: post-mt-manage-5g-tenantueinfo + tags: + - UE Info Resource API + summary: Add UE Mapping + description: Create a new mapping between a tenant and specific User Equipment + (UE) identifiers, including IMSI, IMEI, and APN values. This endpoint binds + unique subscriber hardware to a specific Tenant Service Group (TSG) for targeted + policy application. Use this when onboarding individual devices or static + IoT sensors that require persistent, identity-based security within the 5G + network. requestBody: content: application/json: + schema: + $ref: '#/components/schemas/TenantUEInfoRequest' examples: Add Tenant UE Info: value: - apn: apn@panw.com - imei: '111111789012345' - imsi: '123456789012345' root_tsg_id: '123456891' tsg_id: '123456890' + imei: '111111789012345' + imsi: '123456789012345' + apn: apn@panw.com IMEI Input Size Error: value: - apn: apn@panw.com - imei: '12345678901234' - imsi: '123456789012345' root_tsg_id: '1204544558' tsg_id: '1886576124' + imei: '12345678901234' + imsi: '123456789012345' + apn: apn@panw.com IMSI Input Size Error: value: - apn: apn@panw.com - imei: '123456789012345' - imsi: '12345678901234' root_tsg_id: '1204544558' tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantUEInfoRequest' + imei: '123456789012345' + imsi: '12345678901234' + apn: apn@panw.com responses: '200': + description: Success content: application/json: examples: Add Tenant UE Info: value: data: - apn: apn@panw.com - create_time: 1738446903587 id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - imei: '123456789012340' - imsi: '123456789012345' root_tsg_id: '1204544558' tsg_id: '1886576124' + imei: '123456789012340' + imsi: '123456789012345' + apn: apn@panw.com + create_time: 1738446903587 update_time: 1738446903587 - description: Success '400': + description: Bad Request content: application/json: examples: Duplicate Tenant UE Info: value: - clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f - details: Duplicate UE info errorCode: '60013' message: Duplicate tenant UE information - requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + details: Duplicate UE info service: 5G Management Service - IMEI Input Size Error: + requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + Invalid TSG Id: value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMEI needs to be 15 digits, current length is 27 errorCode: '60014' message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: tsg_id 123456890 does not exist in TenantDetails service: 5G Management Service - IMSI Input Size Error: + requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + IMEI Input Size Error: value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMSI needs to be 15 digits, current length is 27 errorCode: '60014' message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: IMEI needs to be 15 digits, current length is 27 service: 5G Management Service - Invalid TSG Id: + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + IMSI Input Size Error: value: - clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 - details: tsg_id 123456890 does not exist in TenantDetails errorCode: '60014' message: Failed to create tenant UE information - requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + details: IMSI needs to be 15 digits, current length is 27 service: 5G Management Service - description: Bad Request + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: @@ -853,20 +549,17 @@ paths: "Unknown error occurred", "service": "5G Management Service", "requestId": null, "clientRequestId": null}' : value: Internal Server Error - description: Server Error - security: - - Bearer: [] - summary: Create tenant-UE info - tags: - - UE Info Resource + operationId: PostMtManage5gTenantueinfo /mt/manage/5g/tenantUEInfo/delete: post: - description: 'Delete the tenant-user equipment (UE) mapping for the provided - identity ID in bulk. This removes the association between user devices and - tenants. - - ' - operationId: post-mt-manage-5g-tenantueinfo-delete + tags: + - UE Info Resource API + summary: Delete Bulk Mappings + description: Permanently remove multiple Tenant-to-UE mappings from the management + database in a single batch operation. Administrators provide a list of unique + identity IDs to decommission large sets of subscriber equipment simultaneously. + Execute this during fleet refreshes or when offboarding multiple devices from + a specific 5G service plan. requestBody: content: application/json: @@ -881,148 +574,145 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Delete tenant-UE mapping - tags: - - UE Info Resource + operationId: PostMtManage5gTenantueinfoDelete /mt/manage/5g/tenantUEInfo/list: post: - description: 'List tenant-user equipment (UE) information for the provided tenant - ID or group ID. This includes details about the devices associated with the - tenant or group. - - ' - operationId: post-mt-manage-5g-tenantueinfo-list + tags: + - UE Info Resource API + summary: Get Mapping List + description: Retrieve a paginated list of all active Tenant-to-UE mappings associated + with a specific Tenant Service Group (TSG). The response includes technical + details for each mapping, such as IMSI, IMEI, and associated security groups. + Utilize this for periodic audits of subscriber inventories or when verifying + the registration status of regional 5G devices. parameters: - - in: query - name: filter + - name: filter + in: query schema: pattern: ^[a-z]+:\w+(?:,[a-z]+:\w+)*$ type: string - - in: query - name: order + - name: order + in: query schema: pattern: ^[a-z]+:(asc|desc)*$ type: string - - in: query - name: page + - name: page + in: query schema: - default: 0 format: int32 + default: 0 type: integer - - in: query - name: size + - name: size + in: query schema: - default: 50 format: int32 + default: 50 type: integer requestBody: content: application/json: - examples: + schema: + $ref: '#/components/schemas/TenantUEInfoListInput' + examples: List Tenant UE Info: value: tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantUEInfoListInput' responses: '200': + description: Success content: application/json: examples: List Tenant UE Info: value: + totalItems: 2 data: - - apn: apn@panw.com - create_time: 1737682646248 - group: [] - identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a + - identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a + root_tsg_id: '1204544558' + tsg_id: '1886576124' imei: '100411547312190' imsi: '264467605337818' + apn: apn@panw.com + group: [] + create_time: 1737682646248 + update_time: 1737682646248 + - identity_id: 29900486-f87f-475a-803d-12e1ee886e55 root_tsg_id: '1204544558' tsg_id: '1886576124' - update_time: 1737682646248 - - apn: apn@panw.com - create_time: 1737682657616 - group: [] - identity_id: 29900486-f87f-475a-803d-12e1ee886e55 imei: '100454707189790' imsi: '512181509888245' - root_tsg_id: '1204544558' - tsg_id: '1886576124' + apn: apn@panw.com + group: [] + create_time: 1737682657616 update_time: 1737682657616 - totalItems: 2 List Tenant UE Info with Groups: value: + totalItems: 2 data: - - apn: apn@panw.com - create_time: 1737682646248 + - identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a + root_tsg_id: '1204544558' + tsg_id: '1886576124' + imei: '100411547312190' + imsi: '264467605337818' + apn: apn@panw.com group: - group_id: 6e451583-b3ab-4d62-af67-398675ab746f group_name: testgroup - identity_id: a5831ca0-5cf4-46a9-9409-6d55ea5e210a - imei: '100411547312190' - imsi: '264467605337818' + create_time: 1737682646248 + update_time: 1737682646248 + - identity_id: 29900486-f87f-475a-803d-12e1ee886e55 root_tsg_id: '1204544558' tsg_id: '1886576124' - update_time: 1737682646248 - - apn: apn@panw.com - create_time: 1737682657616 - group: [] - identity_id: 29900486-f87f-475a-803d-12e1ee886e55 imei: '100454707189790' imsi: '512181509888245' - root_tsg_id: '1204544558' - tsg_id: '1886576124' + apn: apn@panw.com + group: [] + create_time: 1737682657616 update_time: 1737682657616 - totalItems: 2 - description: Success '204': + description: No Content content: application/json: examples: List Tenant UE Info Invalid TSG Id: value: - data: [] totalItems: 0 - description: No Content + data: [] '400': description: Bad Request '404': description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: List tenant-UE info - tags: - - UE Info Resource + operationId: PostMtManage5gTenantueinfoList /mt/manage/5g/tenantUEInfo/upload: post: - description: 'Upload tenant-user equipment (UE) information in bulk. This allows - for the mass addition of user devices to the system. - - ' - operationId: post-mt-manage-5g-tenantueinfo-upload + tags: + - UE Info Resource API + summary: Upload Tenant Feature + description: Enable specific 5G management features for a tenant by uploading + a configuration file directly to the management plane. This action activates + regional capabilities and tenant-specific policies required for advanced 5G + connectivity. Perform this upload during the feature activation phase to grant + a tenant access to the 5G security framework. requestBody: content: multipart/form-data: - encoding: - file: - contentType: application/octet-stream schema: + type: object properties: file: format: binary type: string filename: type: string - rootTsgId: - type: string tsgId: type: string - type: object + rootTsgId: + type: string + encoding: + file: + contentType: application/octet-stream responses: '200': description: Success @@ -1032,151 +722,106 @@ paths: description: Data Not Found '500': description: Server Error - security: - - Bearer: [] - summary: Upload tenant-UE info - tags: - - UE Info Resource + operationId: PostMtManage5gTenantueinfoUpload /mt/manage/5g/tenantUEInfo/{identity_id}: - delete: - description: 'Delete the Tenant UE mapping for provided identity_id. - - ' - operationId: delete-mt-manage-5g-tenantueinfo-identity_id - parameters: - - in: path - name: identity_id - required: true - schema: - type: string - responses: - '200': - content: - application/json: - examples: - Delete Tenant UE Info: - value: - identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - description: Success - '400': - content: - application/json: - examples: - Tenant UE information not found: - value: - clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - does not exits. - errorCode: '60011' - message: Tenant UE information not found - requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - service: 5G Management Service - description: Bad Request - '404': - description: Data Not Found - '500': - description: Server Error - security: - - Bearer: [] - summary: Delete tenant-UE mapping by ID - tags: - - UE Info Resource put: - description: 'Update the tenant-user equipment (UE) mapping for the provided - identity ID. This modifies the association between user devices and tenants. - - ' - operationId: put-mt-manage-5g-tenantueinfo-identity_id + tags: + - UE Info Resource API + summary: Edit UE Mapping + description: Update the IMSI, IMEI, or APN parameters for an existing Tenant-to-UE + mapping using its unique identifier. This allows administrators to keep subscriber + records accurate as hardware changes or service configurations shift. parameters: - - in: path - name: identity_id + - name: identity_id + in: path required: true schema: type: string requestBody: content: application/json: + schema: + $ref: '#/components/schemas/TenantUEInfoRequest' examples: Edit Tenant UE Info: value: - apn: apn@panw.com - imei: '111111789012345' - imsi: '123456789012345' root_tsg_id: '123456891' tsg_id: '123456890' + imei: '111111789012345' + imsi: '123456789012345' + apn: apn@panw.com IMEI Input Size Error: value: - apn: apn@panw.com - imei: '12345678901234' - imsi: '123456789012345' root_tsg_id: '1204544558' tsg_id: '1886576124' + imei: '12345678901234' + imsi: '123456789012345' + apn: apn@panw.com IMSI Input Size Error: value: - apn: apn@panw.com - imei: '123456789012345' - imsi: '12345678901234' root_tsg_id: '1204544558' tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantUEInfoRequest' + imei: '123456789012345' + imsi: '12345678901234' + apn: apn@panw.com responses: '200': + description: Success content: application/json: examples: Edit Tenant UE Info: value: data: - apn: apn@panw.com - create_time: 1738446903587 id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - imei: '111111789012340' - imsi: '123456789012345' root_tsg_id: '1204544558' tsg_id: '1886576124' + imei: '111111789012340' + imsi: '123456789012345' + apn: apn@panw.com + create_time: 1738446903587 update_time: 1738446903587 - description: Success '400': + description: Bad Request content: application/json: examples: Duplicate Tenant UE Info: value: - clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f - details: Duplicate UE info errorCode: '60013' message: Duplicate tenant UE information - requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + details: Duplicate UE info service: 5G Management Service - IMEI Input Size Error: + requestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + clientRequestId: 9b3655ac-ce40-4e32-a38d-eff42e593d7f + Invalid TSG Id: value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMEI needs to be 15 digits, current length is 27 errorCode: '60014' message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: tsg_id 123456890 does not exist in TenantDetails service: 5G Management Service - IMSI Input Size Error: + requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + IMEI Input Size Error: value: - clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 - details: IMSI needs to be 15 digits, current length is 27 errorCode: '60014' message: Failed to create tenant UE information - requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + details: IMEI needs to be 15 digits, current length is 27 service: 5G Management Service - Invalid TSG Id: + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + IMSI Input Size Error: value: - clientRequestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 - details: tsg_id 123456890 does not exist in TenantDetails errorCode: '60014' message: Failed to create tenant UE information - requestId: 814ea495-87e3-4f41-8ceb-7bec3d09fb23 + details: IMSI needs to be 15 digits, current length is 27 service: 5G Management Service - description: Bad Request + requestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 + clientRequestId: 4934299e-15a1-454e-9f6c-c96c45b6d771 '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: @@ -1184,31 +829,72 @@ paths: "Unknown error occurred", "service": "5G Management Service", "requestId": null, "clientRequestId": null}' : value: Internal Server Error - description: Server Error - security: - - Bearer: [] - summary: Update tenant-UE mapping by ID + operationId: PutMtManage5gTenantueinfoBy_identity_id + delete: tags: - - UE Info Resource + - UE Info Resource API + summary: Delete UE Mapping + description: Remove a single Tenant-to-UE mapping from the management system + to revoke its 5G connectivity and security permissions. Execute this when + a specific device is retired or no longer requires access to the 5G security + solution. + parameters: + - name: identity_id + in: path + required: true + schema: + type: string + responses: + '200': + description: Success + content: + application/json: + examples: + Delete Tenant UE Info: + value: + identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + '400': + description: Bad Request + content: + application/json: + examples: + Tenant UE information not found: + value: + errorCode: '60011' + message: Tenant UE information not found + details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + does not exits. + service: 5G Management Service + requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + '404': + description: Data Not Found + '500': + description: Server Error + operationId: DeleteMtManage5gTenantueinfoBy_identity_id /mt/manage/5g/tenantUEInfo/{ueInfoId}: get: - description: 'Retrieve Tenant UE information Mapping, which includes the mapping - of Tenant, IMSI, IMEI, and APN for the specified ID. - - ' - operationId: get-mt-manage-5g-tenantueinfo-ueinfoid + tags: + - UE Info Resource API + summary: Get Mapping Details + description: Fetch the detailed technical specification of a single Tenant-to-UE + mapping through its unique identifier. The system returns the bound IMSI, + IMEI, and APN data along with registration timestamps. Use this for deep inspection + of a specific subscriber's configuration during troubleshooting or compliance + audits. parameters: - - in: path - name: ueInfoId + - name: ueInfoId + in: path required: true schema: type: string - - in: query - name: unknownUes + - name: unknownUes + in: query schema: type: boolean responses: '200': + description: Success content: application/json: examples: @@ -1224,54 +910,54 @@ paths: tsg_id: '1157492855' update_time: 1738909540647 header: - clientRequestId: 70e19fff-0793-45e7-93db-511ffe26288d createdAt: '2025-02-10T18:47:01.000Z' + clientRequestId: 70e19fff-0793-45e7-93db-511ffe26288d dataCount: 1 status: subCode: 200 - description: Success '400': + description: Bad Request content: application/json: examples: Tenant UE information not found: value: - clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 - details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - does not exits. errorCode: '60011' message: Tenant UE information not found - requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + details: Provided identityId 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 + does not exits. service: 5G Management Service - description: Bad Request + requestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 + clientRequestId: 88df052c-b139-4d47-a8e3-1fcf01ede954 '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: Invalid TSG Id: value: - details: Unknown error occurred errorCode: '60000' message: Unexpected server error + details: Unknown error occurred service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Retrieve UE Mapping - tags: - - UE Info Resource + operationId: GetMtManage5gTenantueinfoBy_ueinfoid /mt/manage/5g/userGroup: post: - description: 'Create a user group with user equipment (UE) information. This - allows for the grouping of user devices for management and policy enforcement. - - ' - operationId: post-mt-manage-5g-usergroup + tags: + - Group Resource API + summary: Add User Group + description: Create a logical group of Tenant User Equipment (UE) identities + to facilitate the application of shared security policies. Administrators + bundle multiple unique UE IDs under a single group name to simplify large-scale + management within a tenant. Use this when defining common access rules for + specific device classes, such as IoT sensors or mobile workforce groups. requestBody: content: application/json: + schema: + $ref: '#/components/schemas/TenantGroupInfo' examples: Add User Group: value: @@ -1280,86 +966,85 @@ paths: - e20f9c45-6f53-4c2f-96fc-7964532d8b83 - e79bda5e-d2ae-4e1d-b0f2-c9318a2b7fa2 tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantGroupInfo' responses: '200': + description: Success content: application/json: examples: Add User Group: value: data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 id: 6e451583-b3ab-4d62-af67-398675ab746f + userGroupName: testgroup + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 tsgId: '1886576124' + createTime: 1738448314169 updateTime: 1738448314412 - userGroupName: testgroup Add User Group with Incorrect Identity ID: value: data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 id: 6e451583-b3ab-4d62-af67-398675ab746f + userGroupName: testgroup + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 tsgId: '1886576124' + createTime: 1738448314169 updateTime: 1738448314412 - userGroupName: testgroup - description: Success '400': + description: Bad Request content: application/json: examples: Add Duplicate User Group Name: value: - clientRequestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 - details: Duplicate user group name testgroup errorCode: '60003' message: Duplicate user group name - requestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 + details: Duplicate user group name testgroup service: 5G Management Service - description: Bad Request + requestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 + clientRequestId: 8e414a6e-51ce-4d71-b272-e00b3f17c961 '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: Internal Server Error: value: - details: Unknown error occurred errorCode: '60000' message: Unexpected server error + details: Unknown error occurred service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Create user group - tags: - - Group Resource + operationId: PostMtManage5gUsergroup /mt/manage/5g/userGroup/list: post: - description: 'List user groups for the provided tenant ID. This includes details - about the groups and their associated user devices. - - ' - operationId: post-mt-manage-5g-usergroup-list + tags: + - Group Resource API + summary: Get Group List + description: Retrieve an inventory of all user groups configured within a specific + Tenant Service Group (TSG). The system provides the group names, member counts, + and unique identifiers required for secondary management actions. Use this + endpoint to audit group structures and monitor device organization across + the 5G management plane. requestBody: content: application/json: + schema: + $ref: '#/components/schemas/TenantGroupInfoListInput' examples: List User Group: value: tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantGroupInfoListInput' responses: '200': + description: Success content: application/json: examples: List User Group: value: + totalItems: 2 data: - group_id: 3ff7689a-c7a8-410c-b973-8ccac5e6d20d group_name: testgroup2 @@ -1369,51 +1054,49 @@ paths: group_name: testgroup tsg_id: '1886576124' user_count: 2 - totalItems: 2 - description: Success '204': + description: No Content content: application/json: examples: List User Group Invalid TSG Id: value: - data: [] totalItems: 0 - description: No Content + data: [] '400': description: Bad Request '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: Internal Server Error: value: - details: Unknown error occurred errorCode: '60000' message: Unexpected server error + details: Unknown error occurred service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: List user groups - tags: - - Group Resource + operationId: PostMtManage5gUsergroupList /mt/manage/5g/userGroup/{groupId}: get: - description: 'Retrieve Tenant UE information IDs for the specified groupId. - - ' - operationId: get-mt-manage-5g-usergroup-groupid + tags: + - Group Resource API + summary: Get Group IDs + description: Fetch the full list of Tenant User Equipment (UE) identifiers associated + with a specific user group. This reveals exactly which devices belong to the + group for detailed policy verification. Access this information when auditing + group membership or verifying the reach of a group-based security policy. parameters: - - in: path - name: groupId + - name: groupId + in: path required: true schema: type: string responses: '200': + description: Success content: application/json: examples: @@ -1430,59 +1113,58 @@ paths: - e38f8ebf-437f-4ca8-a447-42714eae24d6 tsg_id: '1157492855' header: - clientRequestId: 237266cc-8f00-45c8-9122-e551fba2a1fa createdAt: '2025-02-10T18:53:31.000Z' + clientRequestId: 237266cc-8f00-45c8-9122-e551fba2a1fa dataCount: 1 status: subCode: 200 - description: Success '400': + description: Bad Request content: application/json: examples: Invalid User Group: value: - clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' errorCode: '60007' message: User group validation failed - requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' service: 5G Management Service - description: Bad Request + requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: Internal Server Error: value: - details: Unknown error occurred errorCode: '60000' message: Unexpected server error + details: Unknown error occurred service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Retrieve UE IDs - tags: - - Group Resource + operationId: GetMtManage5gUsergroupBy_groupid /mt/manage/5g/userGroup/{group_id}: put: - description: 'Update the user group mapping for the provided group ID. This - modifies the association between user devices and the group. - - ' - operationId: put-mt-manage-5g-usergroup-group_id + tags: + - Group Resource API + summary: Edit User Group + description: Modify the name or member list of an existing user group within + the 5G management plane. Administrators can add or remove UE identifiers to + adjust the scope of group-based security rules. Apply these updates when device + deployments change or when group hierarchies require realignment. parameters: - - in: path - name: group_id + - name: group_id + in: path required: true schema: type: string requestBody: content: application/json: + schema: + $ref: '#/components/schemas/TenantGroupInfo' examples: Edit User Group: value: @@ -1491,78 +1173,76 @@ paths: - e20f9c45-6f53-4c2f-96fc-7964532d8b83 - e79bda5e-d2ae-4e1d-b0f2-c9318a2b7fa2 tsg_id: '1886576124' - schema: - $ref: '#/components/schemas/TenantGroupInfo' responses: '200': + description: Success content: application/json: examples: Edit User Group: value: data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 id: 6e451583-b3ab-4d62-af67-398675ab746f + userGroupName: testgroup + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 tsgId: '1886576124' + createTime: 1738448314169 updateTime: 1738448314412 - userGroupName: testgroup Edit User Group with Incorrect Identity ID: value: data: - cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 - createTime: 1738448314169 id: 6e451583-b3ab-4d62-af67-398675ab746f + userGroupName: testgroup + cieGroupId: 137b7d3b-25b2-446c-b7c4-e40fbf704125 tsgId: '1886576124' + createTime: 1738448314169 updateTime: 1738448314412 - userGroupName: testgroup - description: Success '400': + description: Bad Request content: application/json: examples: Invalid User Group: value: - clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' errorCode: '60007' message: User group validation failed - requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' service: 5G Management Service - description: Bad Request + requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: Internal Server Error: value: - details: Unknown error occurred errorCode: '60000' message: Unexpected server error + details: Unknown error occurred service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Update user group - tags: - - Group Resource + operationId: PutMtManage5gUsergroupBy_group_id /mt/manage/5g/userGroup/{identity_id}: delete: - description: 'Delete the user group mapping for the provided identity ID. This - removes the association between user devices and the group. - - ' - operationId: delete-mt-manage-5g-usergroup-identity_id + tags: + - Group Resource API + summary: Delete User Group + description: Permanently decommission a specific user group and remove its associated + identity mappings from the management database. This action stops the application + of group-level policies without deleting the underlying individual UE records. + Execute this during configuration cleanup or when retiring specific device + classification models. parameters: - - in: path - name: identity_id + - name: identity_id + in: path required: true schema: type: string responses: '200': + description: Success content: application/json: examples: @@ -1572,80 +1252,536 @@ paths: Delete User Group Again: value: identity_id: 45a4ca95-9e8b-4a63-a482-70b7d3aa4fd8 - description: Success '400': + description: Bad Request content: application/json: examples: Invalid User Group: value: - clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae - details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' errorCode: '60007' message: User group validation failed - requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + details: 'No group found for the provided group ID: e2cbebf8-b6b3-405e-ad00-04ad4' service: 5G Management Service - description: Bad Request + requestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae + clientRequestId: 7e2309f1-d50e-4ee6-a9cb-cb45eb0930ae '404': description: Data Not Found '500': + description: Server Error content: application/json: examples: Internal Server Error: value: - details: Unknown error occurred errorCode: '60000' message: Unexpected server error + details: Unknown error occurred service: 5G Management Service - description: Server Error - security: - - Bearer: [] - summary: Delete user group mapping + operationId: DeleteMtManage5gUsergroupBy_identity_id + /mt/manage/5g/register/ue: + post: tags: - - Group Resource + - UE Enrichment + summary: Register UE Device + description: Dynamically register one or more User Equipment (UE) devices with + the 5G management plane by providing their IP Address addresses and subscriber + identifiers. This enrichment process allows the 5G security solution to map + real-time traffic to specific IMSI and IMEI identities. Perform this registration + when using the Application Programming Interface-based integration model to + ensure traffic flows are correctly attributed to tenants. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegisterUE' + examples: + Register UE With mandatory params: + value: + - imsi: '333333333333333' + imei: '333333333333333' + apn: demo.com + ipv4Addr: 172.29.0.8 + ipType: IPv4 + eventTime: 123456789009 + Incorrect Payload: + value: + - imsi: '3333333333333' + imei: '333333333333333' + apn: demo.com + ipv4Addr: 172.29.0.8 + ipType: IPv4 + eventTime: 123456789009 + IP out of Range: + value: + - imsi: '333333333333333' + imei: '333333333333333' + apn: demo.com + ipv4Addr: 192.29.0.8 + ipType: IPv4 + eventTime: 123456789009 + Missing mandory param: + value: + - imsi: '333333333333333' + imei: '333333333333333' + apn: demo.com + ipv4Addr: 172.29.0.8 + ipType: IPv4 + Partially correct payload: + value: + - imsi: '444444444444444' + imei: '444444444444444' + apn: demo.com + ipv4Addr: 172.29.0.10 + ipType: IPv4 + eventTime: 123456789009 + expiryTime: 1234568988 + - imsi: '333333333333444' + imei: '333333333333444' + apn: demo.com + ipv4Addr: 172.29.0.9 + ipType: IPv4 + expiryTime: 1234568988 + msisdn: test + Update expiry Time: + value: + - imsi: '333333333333333' + imei: '333333333333333' + apn: demo.com + ipv4Addr: 172.29.0.8 + ipType: IPv4 + eventTime: 123456789009 + expiryTime: 8765432190 + responses: + '202': + description: Accepted + content: + application/json: + schema: + type: object + examples: + Successful: + summary: Request Accepted + '207': + description: Partial Success + content: + application/json: + schema: + type: object + example: + apn: demo.com + errorMsg: Event time is must + expiryTime: 1234568988 + imei: '333333333333440' + imsi: '333333333333444' + ipType: 0 + ipv4Addr: 172.29.0.9 + msisdn: test + '400': + description: Bad Request + content: + application/json: + schema: + type: object + examples: + example-0: + summary: Incorrect Payload + value: + apn: demo.com + errorMsg: IMSI needs to be 15 digits, current length is 13 + eventTime: 123456789009 + imei: '333333333333333' + imsi: '3333333333333' + ipType: 0 + ipv4Addr: 172.29.0.8 + example-1: + summary: IP Out of Range + value: + apn: demo.com + errorMsg: IP is not a part of any ue cidr block + eventTime: 123456789009 + imei: '333333333333330' + imsi: '333333333333333' + ipType: 0 + ipv4Addr: 192.29.0.8 + example-2: + summary: Missing mandatory param + value: + apn: demo.com + errorMsg: Event time is must + imei: '333333333333330' + imsi: '333333333333333' + ipType: 0 + ipv4Addr: 172.29.0.8 + '401': + description: Unauthorized + content: + application/json: + schema: + type: object + example: + errorCode: '60076' + message: Either 5g is not enabled or interface is not API + details: Interface set is not API + service: 5G Management Service + requestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + clientRequestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + operationId: PostMtManage5gRegisterUe + /mt/manage/5g/deregister/ue: + post: + tags: + - UE Enrichment + summary: Deregister UE Device + description: Terminate the real-time registration of one or more User Equipment + (UE) devices to stop the attribution of traffic to those subscriber identifiers. + This endpoint cleans up the active mapping table when a session ends or a + device disconnects from the 5G network. Use this to maintain an accurate and + up-to-date view of active 5G subscribers within the management plane. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RegisterUE' + examples: + Degister Success: + value: + - imsi: '333333333333333' + imei: '333333333333333' + apn: demo.com + ipv4Addr: 172.29.0.8 + ipType: IPv4 + eventTime: 123456789009 + responses: + '202': + description: Accepted + content: + application/json: + schema: + type: object + examples: + Successful: + summary: Request Accepted + '401': + description: Unauthorized + content: + application/json: + schema: + type: object + example: + errorCode: '60076' + message: Either 5g is not enabled or interface is not API + details: Interface set is not API + service: 5G Management Service + requestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + clientRequestId: fd96df3d-4178-4141-a497-f4b12bc4d5ab + operationId: PostMtManage5gDeregisterUe servers: -- url: https://api.sase.paloaltonetworks.com -tags: -- description: "The Customer Identity and Engagement (CIE) Token Resource API is responsible\ - \ for managing tokens used for authentication and authorization purposes within\ - \ the 5G SASE system. This includes operations such as saving, retrieving, and\ - \ validating CIE tokens for leaf tenants. \nThese tokens are crucial for ensuring\ - \ secure access and interaction with the system's resources.\n" - name: CIE Token Resource API -- description: "The Connection API provides endpoints for retrieving and managing\ - \ connection details across different regions within the 5G SASE system. \nThis\ - \ includes information about the current status, configuration, and performance\ - \ of connections. \nAdministrators can use this API to monitor and optimize network\ - \ connectivity, ensuring efficient and reliable communication.\n" - name: Connection API -- description: "The Control Plane Resource API is responsible for managing control\ - \ plane operations within the 5G SASE system. \nThis includes handling certificates,\ - \ proxy configurations, and RADIUS server secrets. \nThese operations are critical\ - \ for establishing secure communication channels and ensuring the proper functioning\ - \ of the control plane, which orchestrates the overall network management and\ - \ security policies.\n" - name: Control Plane Resource API -- description: 'The User Equipment (UE) Info Resource API manages information related - to user devices within the 5G SASE system. This includes creating, updating, listing, - and deleting tenant-user equipment mappings. - - By managing UE information, this API helps in enforcing security policies, tracking - device usage, and ensuring that user devices are properly associated with their - respective tenants. - - ' - name: UE Info Resource API -- description: "The Group Resource API is responsible for managing user groups within\ - \ the 5G SASE system. This includes creating, updating, listing, and deleting\ - \ groups that contain user equipment (UE) information. \nBy organizing user devices\ - \ into groups, this API facilitates the application of group-based security policies\ - \ and simplifies the management of multiple devices within the network.\n" - name: Group Resource API -- description: "The User Equipment (UE) Enrichment API is designed to augment UE data\ - \ with additional context and security-related information. This includes enriching\ - \ UE profiles with details such as device type, location, user identity, and security\ - \ posture. \nBy enriching this data, the API enables more granular policy enforcement,\ - \ better threat detection, and improved network visibility, helping administrators\ - \ to make more informed decisions about device access and security.\n" - name: UE Enrichment API +- url: https://stratacloudmanager.paloaltonetworks.com +security: +- JWT: [] +components: + schemas: + CSVFieldDelimiter: + enum: + - comma + - semi_colon + - tab + type: string + CieTokenRequest: + type: object + properties: + tsg_id: + type: string + access_token: + type: string + created_by: + type: string + created_at: + type: string + cie_directory: + type: string + CompressionType: + enum: + - gzip + - none + - snappy + type: string + ConnectionRegionEntry: + description: Connection Region Entry + type: object + properties: + computeRegion: + type: string + connectionCount: + format: int32 + type: integer + connectionStatusEntry: + $ref: '#/components/schemas/ConnectionStatusEntry' + bandwidth: + format: int64 + description: Bandwidth in BPS + type: integer + status: + type: string + ConnectionStatusEntry: + type: object + properties: + up: + format: int32 + type: integer + down: + format: int32 + type: integer + Enable5GRequest: + type: object + properties: + compute_region: + type: string + action: + type: string + ipv4_cidr: + type: string + ipv6_cidr: + type: string + JsonObject: + type: array + items: + type: string + RadiusProxyRequest: + type: object + properties: + name: + type: string + ipaddress: + type: string + RadiusServerSecretRequest: + type: object + properties: + secret: + type: string + created_by: + type: string + RegisterUE: + type: array + description: A list of one or more UEs + items: + type: object + properties: + apn: + description: APN (Access Point Name) for the Tenant UE + example: apn@panw.com + type: string + imei: + description: 15 digit IMEI (International Mobile Equipment Identity) number. + Error is returned if number of digits is not exactly 15.Last digit will + be replaced by zero. + example: '123456789012345' + type: string + imsi: + description: 15 digit IMSI (International Mobile Subscriber Identity) + number. Error is returned if number of digits is not exactly 15. + example: '123456789012345' + type: string + ipType: + description: it tells whether it is ipv4, ipv6 or dual stack. Valid values + are IPv4, IPv6, IPv4v6 + example: IPV4 + type: string + ipv4Addr: + type: string + ipv6Addr: + type: string + eventTime: + description: epoc time in ms + type: integer + expiryTime: + description: epoc time in ms + type: integer + sliceId: + type: string + msisdn: + type: string + ratType: + type: string + cellId: + type: string + supi: + type: string + required: + - eventTime + - ipType + - imsi + - imei + - apn + SetInterface: + type: object + properties: + interfaceType: + type: string + example: RADIUS + processInterimMsg: + type: boolean + default: false + interimMsgInterval: + type: integer + description: How often interim messages will come(in minutes) + required: + - interfaceType + TDF: + type: object + properties: + image: + type: string + zclusterIds: + type: array + items: + type: string + TenantGroupInfo: + type: object + properties: + tsg_id: + type: string + identity_id: + type: array + items: + type: string + group_name: + type: string + TenantGroupInfoListInput: + type: object + properties: + tsg_id: + type: string + group_id: + type: string + TenantUEInfoListInput: + type: object + properties: + tsg_id: + type: string + TenantUEInfoRequest: + type: object + properties: + tsg_id: + type: string + imei: + type: string + imsi: + type: string + apn: + type: string + root_tsg_id: + type: string + TenantUeInfoBulkDeleteRequest: + type: object + properties: + identityIds: + type: array + items: + type: string + RequestBody_TenantUeInfoAddEdit: + properties: + mapping: + allOf: + - $ref: '#/components/schemas/TenantUeInfoMapping' + description: Tenant UE Info mapping request body + type: object + required: + - mapping + type: object + RequestBody_TsgId: + properties: + mapping: + allOf: + - $ref: '#/components/schemas/TsgIdInput' + description: TSG (Tenant Subscriber Group) Id Input + type: object + required: + - mapping + type: object + RequestBody_UserGroupAddEdit: + properties: + userGroupInfo: + allOf: + - $ref: '#/components/schemas/UserGroupInfo' + description: User Group mapping request body + type: object + required: + - userGroupInfo + type: object + TenantUeInfoMapping: + properties: + apn: + description: APN (Access Point Name) for the Tenant UE + example: apn@panw.com + type: string + imei: + description: 15 digit IMEI (International Mobile Equipment Identity) number. + Error is returned if number of digits is not exactly 15.Last digit will + be replaced by zero. + example: '123456789012345' + type: string + imsi: + description: 15 digit IMSI (International Mobile Subscriber Identity) number. + Error is returned if number of digits is not exactly 15. + example: '123456789012345' + type: string + root_tsg_id: + description: TSG Id of the Root Tenant. No error is returned if invalid + TSG Id is provided. + example: '1234567891' + type: string + tsg_id: + description: TSG Id of the Child or Enterprise Tenant. Error is returned + if invalid TSG Id is provided. + example: '1234567890' + type: string + required: + - root_tsg_id + - tsg_id + - imsi + - imei + - apn + type: object + TsgIdInput: + properties: + tsg_id: + description: TSG Id of the Child or Enterprise Tenant. Error is returned + if invalid TSG Id is provided. + example: '1234567890' + type: string + required: + - tsg_id + type: object + UpdateInterimMsg: + type: object + properties: + processMsg: + type: boolean + default: false + interval: + type: integer + description: How often interim messages will come(in minutes) + UserGroupInfo: + properties: + group_name: + description: User Group Name. Must be unique across tenants. + example: test_user_group + type: string + identity_id: + description: Array of Tenant UE Info mapping ids + example: 1234567890 + items: + type: string + type: array + tsg_id: + description: TSG Id of the Child or Enterprise Tenant. Error is returned + if invalid TSG Id is provided. + example: '1234567890' + type: string + required: + - group_name + - identity_id + - tsg_id + type: object +ExternalTags: {} diff --git a/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml b/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml new file mode 100644 index 000000000..5e9225a3d --- /dev/null +++ b/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml @@ -0,0 +1,997 @@ +openapi: 3.0.2 +info: + title: SASE 5G Monitor API + version: '1.0' + description: "The SASE 5G Monitoring APIs provide real-time visibility and technical\ + \ telemetry across the 5G infrastructure. These interfaces enable administrators\ + \ to track subscriber scaling, monitor regional registration trends, and audit\ + \ network throughput. By integrating these monitoring endpoints into centralized\ + \ dashboards, organizations can identify unauthorized device mappings, respond\ + \ to security incidents by severity, and ensure that 5G network interconnects\ + \ maintain optimal performance levels. This spec was created on February 06, 2026.\ + \ \xA9 2026 Palo Alto Networks, Inc." +paths: + /mt/monitor/5g/tenants: + get: + tags: + - Total Tenants + summary: Retrieve Total Tenants + description: Access the central management plane to retrieve the total count + of tenants currently provisioned within the 5G environment. This query provides + high-level visibility into ecosystem scale by scanning the active tenant database. + Administrators should execute this check periodically to ensure tenant counts + align with expected licensing and service levels. + responses: + '200': + description: Success + content: + application/json: + example: + data: + total_tenants: 8 + header: + createdAt: '2025-12-17T01:28:33Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gTenants + /mt/monitor/5g/ueIp/registered: + get: + tags: + - Registered UE Mappings + summary: Fetch Registered Mappings + description: Retrieve the current total of successfully registered User Equipment + (UE) device mappings across the entire network. This operation identifies + how many devices have active IP Address assignments by querying the real-time + registration table. Use this data whenever you need to verify the current + load of authenticated devices on the 5G network. + responses: + '200': + description: Success + content: + application/json: + example: + data: + registered_device: 6 + header: + createdAt: '2025-12-17T02:03:07Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gUeipRegistered + /mt/monitor/5g/ueIp/region: + get: + tags: + - UE IP Region + summary: List Registered Regions + description: View a list of all geographical compute regions where User Equipment + (UE) devices are currently registered. This endpoint scans regional gateways + to identify active subscriber locations. Perform this query to determine the + global distribution of 5G traffic and ensure that subscribers are connecting + to the intended regional nodes. + responses: + '200': + description: Success + content: + application/json: + example: + data: + - compute_region: us-west2 + header: + createdAt: '2025-12-17T02:06:52Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gUeipRegion + /mt/monitor/5g/ueIp/registered/trend: + post: + tags: + - 5G Registered Trend + summary: Analyze Registration Trends + description: Generate a historical trend report showing the rate of successful + UE device registrations over a specified time interval. By submitting a TrendRequest + with filtering parameters, you can identify growth patterns or sudden spikes + in device connectivity. Use this analysis to forecast capacity requirements + and detect anomalies in subscriber behavior. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrendRequest' + example: + properties: + - property: imei + function: count + alias: registered_count + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 7 + - property: compute_region + operator: in + values: + - us-central1 + histogram: + property: event_time + range: day + enableEmptyInterval: false + value: '1' + responses: + '200': + description: Success + content: + application/json: + example: + data: + - event_time: 1765324800000 + registered_count: 4 + - event_time: 1765411200000 + registered_count: 4 + header: + createdAt: '2025-12-17T02:05:29Z' + clientRequestId: null + dataCount: 7 + status: + subCode: 200 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gUeipRegisteredTrend + /mt/monitor/5g/ueIp/deregistered/trend: + post: + tags: + - 5G Deregistered Trend + summary: Monitor Deregistration Trends + description: Track the trend of devices disconnecting or deregistering from + the 5G network over time. This endpoint processes historical telemetry to + show when and where UE mappings are cleared. Monitor these trends to identify + potential network stability issues or scheduled device maintenance windows + that impact active subscriber counts. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrendRequest' + example: + properties: + - property: imei + function: count + alias: deregistered_count + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 7 + - property: compute_region + operator: in + values: + - us-central1 + histogram: + property: event_time + range: day + enableEmptyInterval: false + value: '1' + responses: + '200': + description: Success + content: + application/json: + example: + data: + - event_time: 1765324800000 + deregistered_count: 3 + - event_time: 1765411200000 + deregistered_count: 3 + header: + createdAt: '2025-12-17T02:05:42Z' + clientRequestId: null + dataCount: 7 + status: + subCode: 200 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gUeipDeregisteredTrend + /mt/monitor/5g/ueIp/count: + post: + tags: + - Added and Cleared Mappings + summary: Count Mapping Changes + description: Retrieve a summary count of all UE IP Address mappings that were + either added or cleared during a specific timeframe. This query uses time-based + filters to provide a snapshot of network "churn" or movement. Execute this + to audit how frequently IP Address assignments change within your 5G subscriber + pool. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CountFilterRequest' + example: + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 7 + responses: + '200': + description: Success + content: + application/json: + example: + data: + add_count: 28 + delete_count: 19 + header: + createdAt: '2025-12-17T02:07:14Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gUeipCount + /mt/monitor/5g/unknownIp/region: + get: + tags: + - Unknown IP Regions + summary: Locate Unknown IPs + description: Identify the compute regions where the system has detected 5G traffic + from unknown or unmapped IP Address addresses. This endpoint scans regional + traffic logs to find packets that lack a valid subscriber identity. Use this + information to investigate potential security breaches or configuration errors + in specific regional gateways. + responses: + '200': + description: Success + content: + application/json: + example: + data: + - compute_region: us-west2 + header: + createdAt: '2025-12-17T02:04:26Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gUnknownipRegion + /mt/monitor/5g/unknownIp/trend: + post: + tags: + - 5G Unknown IPs Trend + summary: Track Unknown IPs + description: Monitor the historical trend of unknown IP Address address detections + over a defined period. By analyzing these trends, you can determine if unauthorized + traffic is increasing or if specific regions are consistently seeing unmapped + devices. Use this telemetry to refine your UE registration policies and improve + network-based security. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrendRequest' + example: + properties: + - property: ip_address + function: distinct_count + alias: count + - property: compute_region + alias: region + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 7 + - property: compute_region + operator: in + values: + - us-central1 + histogram: + property: event_time + range: day + enableEmptyInterval: false + value: '1' + responses: + '200': + description: Success + content: + application/json: + example: + data: + - region: us-central1 + event_time: 1765324800000 + count: 13 + - region: us-central1 + event_time: 1765411200000 + count: 7 + header: + createdAt: '2025-12-17T02:05:04Z' + clientRequestId: null + dataCount: 8 + status: + subCode: 200 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gUnknownipTrend + /mt/monitor/5g/mapping/activeUEs: + get: + tags: + - Active Mappings + summary: Identify Active Mappings + description: Query the 5G management plane to retrieve the exact count of UE + mappings that are currently active and passing traffic. This distinguishes + between "registered" devices and those that are "actively" communicating. + Perform this check to assess real-time network utilization and active session + density. + responses: + '200': + description: Success + content: + application/json: + example: + data: + active_mappings: 4 + header: + createdAt: '2025-12-17T02:05:18Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gMappingActiveues + /mt/monitor/5g/mapping/configuredUEs: + get: + tags: + - Configured UE Mappings + summary: List Configured Mappings + description: Retrieve the count of all UE mappings that have been manually configured + by administrators within the system. This provides a baseline of "known-good" + devices that are authorized for 5G access. Compare this count against active + registrations to identify if configured devices are failing to connect. + responses: + '200': + description: Success + content: + application/json: + example: + data: + configured_ue_count: 94 + header: + createdAt: '2025-12-17T02:07:37Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gMappingConfiguredues + /mt/monitor/5g/mapping/unknownUEs: + get: + tags: + - Unknown UE Mappings + summary: Detect Unknown Mappings + description: Identify User Equipment (UE) mappings that were registered through + automated methods, such as RADIUS or Application Programming Interface, but + were never explicitly configured by a user. This check highlights "shadow" + devices or guest equipment that has entered the network. Review these mappings + to ensure that automated registration flows are not introducing unauthorized + devices. + responses: + '200': + description: Success + content: + application/json: + example: + data: + unknown_mappings: 1 + header: + createdAt: '2025-12-17T02:07:45Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gMappingUnknownues + /mt/monitor/5g/mapping/region: + get: + tags: + - Region + summary: List Mapping Regions + description: Access a regional breakdown of where specific 5G UE mappings currently + exist across the compute infrastructure. This endpoint allows you to see the + footprint of your 5G subscriber base. Use this when planning regional security + policy deployments or during network maintenance to understand which regions + have the highest mapping density. + responses: + '200': + description: Success + content: + application/json: + example: + data: + - us-west2 + - us-central1 + header: + createdAt: '2025-12-17T02:10:45Z' + clientRequestId: null + dataCount: 2 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gMappingRegion + /mt/monitor/5g/mapping: + post: + tags: + - UE Mappings + summary: Query Mapping Details + description: Search for specific UE mapping details using IMSI, IMEI, or IP + Address Address identifiers across your 5G tenant base. This endpoint supports + advanced filtering and pagination to handle large datasets. Use this detailed + search capability when troubleshooting connectivity for a specific device + or performing a security audit on a particular subscriber. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MappingRequest' + examples: + Paginated List: + value: + pageSize: 100 + pageNum: 0 + Paginated List With Tenant Filter: + value: + pageSize: 100 + pageNum: 0 + tenant: + - '1459340040' + - '1635727460' + Paginated List With Region Filter: + value: + pageSize: 100 + pageNum: 0 + region: us-west2 + Paginated List With Region and Tenant Filter: + value: + pageSize: 100 + pageNum: 0 + region: us-west2 + tenant: + - '1459340040' + - '1635727460' + Search with Pagination: + value: + searchKey: '500012222222222' + pageSize: 100 + pageNum: 0 + Search with Pagination and Filtering: + value: + searchKey: '310260418380113' + pageSize: 100 + pageNum: 0 + region: us-west2 + tenant: + - '1459340040' + - '1635727460' + responses: + '200': + description: Success + content: + application/json: + examples: + Single Mapping: + value: + data: + mappings: + - apn: demo.com + createTime: 1737113951692 + groups: new_grp + imei: '000000000000000' + imsi: '500012222222222' + tenantProvisioned: Inactive + tsgId: '1131085573' + totalCount: 1 + header: + createdAt: '2025-12-17T02:07:58Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + Multiple Mappings: + value: + data: + mappings: + - apn: pan.pcweb.comm + createTime: 1759426780582 + imei: '000000000000000' + imsi: '310260418380113' + tenantProvisioned: Inactive + tsgId: '1558164857' + - apn: pan.fast.comm + createTime: 1759426957812 + imei: '359414782481750' + imsi: '310260418380113' + tenantProvisioned: Inactive + tsgId: '1558164857' + totalCount: 2 + header: + createdAt: '2025-12-17T02:08:33Z' + clientRequestId: null + dataCount: 2 + status: + subCode: 200 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gMapping + /mt/monitor/5g/proxy: + get: + tags: + - Total Proxies + summary: Retrieve Proxy Counts + description: Get a count of all proxy servers that have been configured by the + client to handle 5G control plane traffic. This visibility ensures that the + required infrastructure nodes are accounted for in the management plane. Execute + this query during infrastructure audits to verify that all intended proxy + servers are visible to the 5G management service. + responses: + '200': + description: Success + content: + application/json: + example: + data: + count: 5 + header: + createdAt: '2025-12-17T02:05:51Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gProxy + /mt/monitor/5g/incidents/count: + post: + tags: + - Incidents by Severity + summary: Filter Security Incidents + description: Categorize and count security incidents based on their assigned + severity levels (Critical, Warning, etc.) over a specific timeframe. By applying + severity filters, administrators can prioritize their response to high-impact + network threats. Use this endpoint to generate executive security summaries + or to trigger automated alerts for critical 5G incidents. + parameters: + - name: agg_by + in: query + schema: + type: string + enum: + - tenant + description: Aggregation parameter + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IncidentsCountRequest' + example: + properties: + - property: total_count + - property: critical_count + - property: warning_count + filter: + rules: + - property: raised_time + operator: last_n_days + values: + - 7 + - property: status + operator: equals + values: + - Raised + - property: severity + operator: in + values: + - Critical + - Warning + - property: domain + operator: in + values: + - External + - external + responses: + '200': + description: Success + content: + application/json: + example: + data: + - total_count: 680 + critical_count: 340 + warning_count: 0 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gIncidentsCount + /mt/monitor/5g/api/stats: + post: + tags: + - API Stats + summary: Review Application Programming Interface Performance + description: Monitor the success and failure rates of Application Programming + Interface calls made specifically through the 5G interface. This telemetry + identifies integration health by tracking total calls, error counts, and response + statuses. Use these statistics to troubleshoot 5G management service connectivity + or to audit the performance of external automation tools. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CountFilterRequest' + example: + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 7 + responses: + '200': + description: Success + content: + application/json: + example: + data: + total_count: 0 + success_count: 0 + failure_count: 0 + header: + createdAt: '2025-12-17T02:06:39Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gApiStats + /mt/monitor/5g/interconnect/details: + get: + tags: + - 5G Network Interconnects and Bandwidth + summary: Examine Interconnect Status + description: Retrieve technical details regarding 5G Network Interconnects, + including available bandwidth and regional connection status. The system reports + on the health of individual VLAN attachments (Up/Down) to ensure physical-to-virtual + infrastructure continuity. Use this information to troubleshoot regional connectivity + outages or to verify bandwidth allocations. + responses: + '200': + description: Success + content: + application/json: + example: + data: + - bandwidth: 200 + regions: + - us-east1 + - us-west2 + - us-central1 + vlanStatus: + down: 0 + total: 8 + up: 8 + header: + createdAt: '2025-12-17T02:07:25Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gInterconnectDetails + /mt/monitor/5g/interconnect/throughput: + post: + tags: + - Throughput Trend + summary: Analyze Network Throughput + description: Analyze the ingress and egress throughput trends for specific 5G + Network Interconnects over a historical timeline. By identifying peak traffic + periods and average data rates, administrators can make informed decisions + about capacity planning. Access this telemetry to ensure that 5G traffic remains + within the provisioned bandwidth limits for each region. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ThroughputRequest' + example: + properties: + - property: egress_throughput + - property: ingress_throughput + - property: event_time + - property: region + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 7 + - property: region + operator: equals + values: + - us-central1 + histogram: + property: event_time + range: day + enableEmptyInterval: false + value: '1' + responses: + '200': + description: Success + content: + application/json: + example: + data: + - egress_throughput: 0.002508770165798529 + ingress_throughput: 0.003023766583801299 + event_time: 1765324800000 + region: us-central1 + - egress_throughput: 0.0027237501165300205 + ingress_throughput: 0.0034827909235609217 + event_time: 1765411200000 + region: us-central1 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gInterconnectThroughput + /mt/monitor/5g/users: + get: + tags: + - Total Number of Configured Users + summary: Count Total Users + description: Retrieve the absolute total of configured users authorized for + the 5G service across all managed tenants. This count serves as a primary + metric for understanding the total administrative scale of the environment. + Check this value when performing global user audits or when reviewing total + service adoption metrics. + responses: + '200': + description: Success + content: + application/json: + example: + data: + total_users: 5000 + header: + createdAt: '2025-12-17T02:08:46Z' + clientRequestId: null + dataCount: 1 + status: + subCode: 200 + '401': + description: Permission Denied + '500': + description: Server Error + operationId: GetMtMonitor5gUsers +servers: +- url: https://stratacloudmanager.paloaltonetworks.com +security: +- JWT: [] +components: + schemas: + TrendRequest: + type: object + properties: + properties: + type: array + items: + type: object + properties: + property: + type: string + function: + type: string + alias: + type: string + filter: + type: object + properties: + operator: + type: string + rules: + type: array + items: + type: object + properties: + property: + type: string + operator: + type: string + values: + type: array + items: {} + histogram: + type: object + properties: + property: + type: string + range: + type: string + enableEmptyInterval: + type: boolean + value: + type: string + CountFilterRequest: + type: object + properties: + filter: + type: object + properties: + operator: + type: string + rules: + type: array + items: + type: object + properties: + property: + type: string + operator: + type: string + values: + type: array + items: {} + MappingRequest: + type: object + properties: + pageSize: + type: integer + format: int32 + pageNum: + type: integer + format: int32 + searchKey: + type: string + region: + type: string + tenant: + type: array + items: + type: string + IncidentsCountRequest: + type: object + properties: + properties: + type: array + items: + type: object + properties: + property: + type: string + filter: + type: object + properties: + rules: + type: array + items: + type: object + properties: + property: + type: string + operator: + type: string + values: + type: array + items: {} + ThroughputRequest: + type: object + properties: + properties: + type: array + items: + type: object + properties: + property: + type: string + filter: + type: object + properties: + operator: + type: string + rules: + type: array + items: + type: object + properties: + property: + type: string + operator: + type: string + values: + type: array + items: {} + histogram: + type: object + properties: + property: + type: string + range: + type: string + enableEmptyInterval: + type: boolean + value: + type: string +ExternalTags: {} diff --git a/products/sase/api/manage-services-5g/introduction.md b/products/sase/api/manage-services-5g/introduction.md index 8d575174e..7f03aa403 100644 --- a/products/sase/api/manage-services-5g/introduction.md +++ b/products/sase/api/manage-services-5g/introduction.md @@ -1,8 +1,7 @@ --- -id: introduction_5g +id: introduction title: Introduction to SASE 5G Manage Service sidebar_label: SASE 5G Manage Service APIs -slug: /sase/api/manage-services-5g keywords: - SASE - Reference diff --git a/products/sase/api/manage-services-5g/overview.md b/products/sase/api/manage-services-5g/overview.md index a73306fa9..fdc08b311 100644 --- a/products/sase/api/manage-services-5g/overview.md +++ b/products/sase/api/manage-services-5g/overview.md @@ -1,5 +1,5 @@ --- -id: overview_5g +id: overview title: Overview of SASE 5G Manage Service sidebar_label: Overview keywords: diff --git a/products/sase/api/monitor-services-5g/introduction_monitor.md b/products/sase/api/monitor-services-5g/introduction_monitor.md new file mode 100644 index 000000000..a479851f3 --- /dev/null +++ b/products/sase/api/monitor-services-5g/introduction_monitor.md @@ -0,0 +1,16 @@ +--- +id: introduction_monitor +title: Introduction to SASE 5G Monitor Service +sidebar_label: SASE 5G Monitor Service APIs +keywords: + - SASE + - Reference + - API +--- + +The SASE 5G Monitoring APIs provide real-time visibility and technical telemetry across the 5G infrastructure. These interfaces enable administrators to track subscriber scaling, monitor regional registration trends, and audit network throughput. By integrating these monitoring endpoints into centralized dashboards, organizations can identify unauthorized device mappings, respond to security incidents by severity, and ensure that 5G network interconnects maintain optimal performance levels. + + +These APIs use the [common SASE authentication](/sase/docs/getstarted) for service access and authorization. + + diff --git a/products/sase/sidebars.ts b/products/sase/sidebars.ts index f98cf2e01..89c62af35 100644 --- a/products/sase/sidebars.ts +++ b/products/sase/sidebars.ts @@ -331,10 +331,14 @@ module.exports = { ], manageservices: [ - "sase/api/manage-services-5g/introduction_5g", - "sase/api/manage-services-5g/overview_5g", + "sase/api/manage-services-5g/introduction", + "sase/api/manage-services-5g/overview", require("./api/manage-services-5g/sidebar"), ], + monitorservices: [ + "sase/api/monitor-services-5g/introduction_monitor", + require("./api/monitor-services-5g/sidebar"), + ], configorch: [ "sase/api/config-orch/introduction", "sase/api/config-orch/api-workflow", From c340db311fb328d16bfdf0243d249403105a1721 Mon Sep 17 00:00:00 2001 From: sra Date: Mon, 9 Feb 2026 19:39:58 +0530 Subject: [PATCH 9/9] DOCS-8900 Updated SP Interconnect monitor APIs spec file. Added $ref for request body --- .../manage-services-5g/5G-Manage-new.yaml | 2 +- .../sase/monitor-services-5g/5G-monitor.yaml | 75 ++---- .../Manage/SP-Interconnect-Manage.yaml | 2 +- .../Monitor/SP-Interconnect-Monitor.yaml | 236 +++++++++++++++++- 4 files changed, 255 insertions(+), 60 deletions(-) diff --git a/openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml b/openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml index 65a321097..8d6af86ae 100644 --- a/openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml +++ b/openapi-specs/sase/manage-services-5g/5G-Manage-new.yaml @@ -15,7 +15,7 @@ info: \ - one that combines scalability, ease of management, \nand comprehensive protection\ \ across all 5G scenarios. \nThe Enterprise 5G Security Solution emerges as the\ \ answer to these pressing needs, \noffering a new approach to securing the future\ - \ of enterprise connectivity. This spec was created on February 06, 2026. \xA9\ + \ of enterprise connectivity. This spec was created on February 09, 2026. \xA9\ \ 2026 Palo Alto Networks, Inc." paths: /mt/manage/5g/cie/token: diff --git a/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml b/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml index 5e9225a3d..b6fca9296 100644 --- a/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml +++ b/openapi-specs/sase/monitor-services-5g/5G-monitor.yaml @@ -8,7 +8,7 @@ info: \ network throughput. By integrating these monitoring endpoints into centralized\ \ dashboards, organizations can identify unauthorized device mappings, respond\ \ to security incidents by severity, and ensure that 5G network interconnects\ - \ maintain optimal performance levels. This spec was created on February 06, 2026.\ + \ maintain optimal performance levels. This spec was created on February 09, 2026.\ \ \xA9 2026 Palo Alto Networks, Inc." paths: /mt/monitor/5g/tenants: @@ -73,7 +73,7 @@ paths: get: tags: - UE IP Region - summary: List Registered Regions + summary: Get UEs Region description: View a list of all geographical compute regions where User Equipment (UE) devices are currently registered. This endpoint scans regional gateways to identify active subscriber locations. Perform this query to determine the @@ -102,7 +102,7 @@ paths: post: tags: - 5G Registered Trend - summary: Analyze Registration Trends + summary: Get Registered UE Trend description: Generate a historical trend report showing the rate of successful UE device registrations over a specified time interval. By submitting a TrendRequest with filtering parameters, you can identify growth patterns or sudden spikes @@ -162,7 +162,7 @@ paths: post: tags: - 5G Deregistered Trend - summary: Monitor Deregistration Trends + summary: Get DeRegistered UE Trend description: Track the trend of devices disconnecting or deregistering from the 5G network over time. This endpoint processes historical telemetry to show when and where UE mappings are cleared. Monitor these trends to identify @@ -360,12 +360,8 @@ paths: get: tags: - Active Mappings - summary: Identify Active Mappings - description: Query the 5G management plane to retrieve the exact count of UE - mappings that are currently active and passing traffic. This distinguishes - between "registered" devices and those that are "actively" communicating. - Perform this check to assess real-time network utilization and active session - density. + summary: Get Active UE Mappings + description: Returns the number of active UE mappings. responses: '200': description: Success @@ -389,11 +385,8 @@ paths: get: tags: - Configured UE Mappings - summary: List Configured Mappings - description: Retrieve the count of all UE mappings that have been manually configured - by administrators within the system. This provides a baseline of "known-good" - devices that are authorized for 5G access. Compare this count against active - registrations to identify if configured devices are failing to connect. + summary: Get Configured UE Mappings + description: Returns the number of UEs configured by the users. responses: '200': description: Success @@ -447,12 +440,8 @@ paths: get: tags: - Region - summary: List Mapping Regions - description: Access a regional breakdown of where specific 5G UE mappings currently - exist across the compute infrastructure. This endpoint allows you to see the - footprint of your 5G subscriber base. Use this when planning regional security - policy deployments or during network maintenance to understand which regions - have the highest mapping density. + summary: Get 5G Mapping Region + description: Returns the list of regions where mappings exist. responses: '200': description: Success @@ -614,12 +603,8 @@ paths: post: tags: - Incidents by Severity - summary: Filter Security Incidents - description: Categorize and count security incidents based on their assigned - severity levels (Critical, Warning, etc.) over a specific timeframe. By applying - severity filters, administrators can prioritize their response to high-impact - network threats. Use this endpoint to generate executive security summaries - or to trigger automated alerts for critical 5G incidents. + summary: Get Incidents By Severity + description: Returns the count of incidents based on severity levels. parameters: - name: agg_by in: query @@ -679,12 +664,10 @@ paths: post: tags: - API Stats - summary: Review Application Programming Interface Performance - description: Monitor the success and failure rates of Application Programming - Interface calls made specifically through the 5G interface. This telemetry - identifies integration health by tracking total calls, error counts, and response - statuses. Use these statistics to troubleshoot 5G management service connectivity - or to audit the performance of external automation tools. + summary: Get Application Programming Interface Stats + description: Returns the total Application Programming Interface calls made + and count of success and failure calls. Applicable for interface type Application + Programming Interface. requestBody: content: application/json: @@ -725,12 +708,8 @@ paths: get: tags: - 5G Network Interconnects and Bandwidth - summary: Examine Interconnect Status - description: Retrieve technical details regarding 5G Network Interconnects, - including available bandwidth and regional connection status. The system reports - on the health of individual VLAN attachments (Up/Down) to ensure physical-to-virtual - infrastructure continuity. Use this information to troubleshoot regional connectivity - outages or to verify bandwidth allocations. + summary: Get Interconnect Details + description: Returns total bandwidth, region list and 5G Network Connections. responses: '200': description: Success @@ -762,12 +741,8 @@ paths: post: tags: - Throughput Trend - summary: Analyze Network Throughput - description: Analyze the ingress and egress throughput trends for specific 5G - Network Interconnects over a historical timeline. By identifying peak traffic - periods and average data rates, administrators can make informed decisions - about capacity planning. Access this telemetry to ensure that 5G traffic remains - within the provisioned bandwidth limits for each region. + summary: Get Throughput Trend + description: Returns the throughput trend data for egress and ingress traffic. requestBody: content: application/json: @@ -821,12 +796,8 @@ paths: get: tags: - Total Number of Configured Users - summary: Count Total Users - description: Retrieve the absolute total of configured users authorized for - the 5G service across all managed tenants. This count serves as a primary - metric for understanding the total administrative scale of the environment. - Check this value when performing global user audits or when reviewing total - service adoption metrics. + summary: Get Total Configured Users + description: Returns the total count of configured users. responses: '200': description: Success @@ -849,7 +820,7 @@ paths: servers: - url: https://stratacloudmanager.paloaltonetworks.com security: -- JWT: [] +- BearerAuth: [] components: schemas: TrendRequest: diff --git a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml index 8f88d1455..eac272711 100644 --- a/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml +++ b/openapi-specs/sase/mt-interconnect/Manage/SP-Interconnect-Manage.yaml @@ -9,7 +9,7 @@ info: \ public cloud backbones. Use these tools during initial deployment or regional\ \ expansion to provision high-capacity physical and virtual links. \nBy submitting\ \ specific regional and partner parameters, you can automate the creation of shared\ - \ or dedicated per-tenant infrastructure. This spec was created on February 04,\ + \ or dedicated per-tenant infrastructure. This spec was created on February 09,\ \ 2026. \xA9 2026 Palo Alto Networks, Inc." paths: /mt/sp-interconnect/interconnects: diff --git a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml index 1ea675e52..189981064 100644 --- a/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml +++ b/openapi-specs/sase/mt-interconnect/Monitor/SP-Interconnect-Monitor.yaml @@ -1,6 +1,6 @@ openapi: 3.1.0 info: - title: SP Interconnect APIs + title: SP Interconnect Monitor APIs version: '1.0' description: "These APIs deliver real-time visibility and performance analytics\ \ for all configured interconnect \nresources through the monitoring plane. They\ @@ -9,7 +9,7 @@ info: \ these metrics during routine audits or active troubleshooting to diagnose latency\ \ spikes or BGP session instability. \nBy applying time-based filters and histograms,\ \ you can generate detailed traffic trends and monitor IP pool consumption across\ - \ your global infrastructure. Created on February 04, 2026. \xA9 2026 Palo Alto\ + \ your global infrastructure. Created on February 09, 2026. \xA9 2026 Palo Alto\ \ Networks, Inc." paths: /mt/sp-interconnect/monitor/vlanAttachments/stats: @@ -28,6 +28,8 @@ paths: requestBody: content: application/json: + schema: + $ref: '#/components/schemas/MonitorRequest' example: properties: - property: ingress_throughput @@ -52,6 +54,27 @@ paths: responses: '200': description: Success + content: + application/json: + example: + data: + - cloudProvider: GCP + cloudRouterIp: 169.254.23.177/29 + cloudRouterIpv6: 2600:2d00:0:1:8000:25:4:7879/125 + createTime: 1737611965296 + egress_throughput: 0.0011975343058471016 + ingress_throughput: 0.0017068013320864356 + interconnect_id: c4ac1cc9-684e-11f0-92e9-4201ac16024e + interconnect_name: ic-us-east1 + region: us-east1 + state: ACTIVE_BGP_UP_BGP_IPV6_UP + status: ACTIVE + tenants: 0 + up_time: 1763134414000 + updateTime: 1763755310226 + vlan_attachment_id: 9764ced6-ef10-437e-80a4-d7609dee6264 + vlan_attachment_name: us-east-1-add-2 + requestId: 45759649-4f0f-41b7-a8d2-766f924eaf67 '400': description: Bad Request '401': @@ -81,6 +104,8 @@ paths: requestBody: content: application/json: + schema: + $ref: '#/components/schemas/MonitorRequest' examples: Egress Traffic Last N Days: value: @@ -101,9 +126,75 @@ paths: operator: equals values: - c4ac1d7a-684e-11f0-92e9-4201ac16024e + Traffic Over Time: + value: + properties: + - property: egress_traffic + function: sum + - property: ingress_traffic + function: sum + - property: interconnect_name + sort: + order: asc + filter: + operator: AND + rules: + - property: event_time + operator: last_n_days + values: + - 30 + - property: interconnect_id + operator: in + values: + - c4ac1d7a-684e-11f0-92e9-4201ac16024e + histogram: + property: event_time + range: day + enableEmptyInterval: false + value: '1' + Lifetime Traffic: + value: + properties: + - property: interconnect_name + sort: + order: asc + - function: sum + property: egress_traffic + filter: + operator: AND + rules: + - property: event_time + operator: lessThan + values: + - '1766104066466' + - property: interconnect_id + operator: equals + values: + - c4ac1d7a-684e-11f0-92e9-4201ac16024e responses: '200': description: Success + content: + application/json: + examples: + Egress Traffic: + value: + data: + - interconnect_name: ic-us-central1 + egress_traffic: 73.40927790249995 + requestId: c39c2083-2aa0-4255-9b22-d87c75ec6ade + Traffic Over Time: + value: + data: + - interconnect_name: ic-us-central1 + event_time: 1763424000000 + egress_traffic: 25.912407871000052 + ingress_traffic: 50.45267106150007 + - interconnect_name: ic-us-central1 + event_time: 1763510400000 + egress_traffic: 26.001434308999958 + ingress_traffic: 48.22614097999999 + requestId: c9369eee-108d-4ab8-8498-15bcbb6cf55e '400': description: Bad Request '401': @@ -126,6 +217,8 @@ paths: requestBody: content: application/json: + schema: + $ref: '#/components/schemas/MonitorRequest' example: properties: - property: egress_throughput @@ -151,6 +244,19 @@ paths: responses: '200': description: Success + content: + application/json: + example: + data: + - egress_throughput: 0.002407656942160277 + ingress_throughput: 0.004687820775191641 + event_time: 1763424000000 + interconnect_name: ic-us-central1 + - egress_throughput: 0.0024075402109722268 + ingress_throughput: 0.0044653834247916635 + event_time: 1763510400000 + interconnect_name: ic-us-central1 + requestId: 3fb923a8-0077-443b-a334-07b3cd2123ed '400': description: Bad Request '401': @@ -173,6 +279,8 @@ paths: requestBody: content: application/json: + schema: + $ref: '#/components/schemas/MonitorRequest' example: properties: - property: egress_throughput @@ -199,6 +307,19 @@ paths: responses: '200': description: Success + content: + application/json: + example: + data: + - vlan_attachment_name: us-centrl-con-2 + event_time: 1763424000000 + egress_throughput: 0.0012025526091289183 + ingress_throughput: 0.0019499224276655067 + - vlan_attachment_name: us-centrl-con-2 + event_time: 1763510400000 + egress_throughput: 0.001203609572708337 + ingress_throughput: 0.0017978866898611117 + requestId: 8bcffcf2-5cba-4ed6-bc63-ed1e8a60bec6 '400': description: Bad Request '401': @@ -221,6 +342,8 @@ paths: requestBody: content: application/json: + schema: + $ref: '#/components/schemas/MonitorRequest' example: properties: - property: egress_traffic @@ -247,6 +370,19 @@ paths: responses: '200': description: Success + content: + application/json: + example: + data: + - vlan_attachment_name: us-centrl-con-2 + event_time: 1763424000000 + egress_traffic: 12.942472452499988 + ingress_traffic: 20.98604013349996 + - vlan_attachment_name: us-centrl-con-2 + event_time: 1763510400000 + egress_traffic: 12.99898336799997 + ingress_traffic: 19.417176225000027 + requestId: 3291624f-4e40-4b10-9a9c-9851c8bbbd82 '400': description: Bad Request '401': @@ -269,6 +405,8 @@ paths: requestBody: content: application/json: + schema: + $ref: '#/components/schemas/MonitorRequest' example: properties: - property: latency @@ -293,6 +431,20 @@ paths: responses: '200': description: Success + content: + application/json: + example: + data: + - vlan_attachment_name: us-centrl-con-2 + event_time: 1766016000000 + latency: 4.204661846160889 + - vlan_attachment_name: us-centrl-con-2 + event_time: 1765238400000 + latency: 3.15822172164917 + - vlan_attachment_name: us-centrl-con-2 + event_time: 1764115200000 + latency: 4.052086353302002 + requestId: 8e701533-5ab3-4815-90af-b4da543804a9 '400': description: Bad Request '401': @@ -323,6 +475,31 @@ paths: responses: '200': description: Success + content: + application/json: + example: + data: + - configuredIps: 16 + createTime: 1734992147821 + incidentCount: 1 + ipBlockType: SECONDARY + ipProvider: SP + location: US Central + percentageUsed: 100 + region: us-central1 + updateTime: 1734992205233 + usedIps: 16 + - configuredIps: 4 + createTime: 1734992147821 + incidentCount: 1 + ipBlockType: PRIMARY + ipProvider: SP + location: US Central + percentageUsed: 100 + region: us-central1 + updateTime: 1734992205233 + usedIps: 4 + requestId: 4c06b78f-caa4-4be9-ab90-c58c3855bd8c '400': description: Bad Request '401': @@ -333,11 +510,58 @@ paths: servers: - url: https://api.sase.paloaltonetworks.com security: -- BearerAuth: [] +- authKey: [] components: + schemas: + MonitorRequest: + type: object + properties: + properties: + type: array + items: + type: object + properties: + property: + type: string + function: + type: string + alias: + type: string + sort: + type: object + properties: + order: + type: string + filter: + type: object + properties: + operator: + type: string + rules: + type: array + items: + type: object + properties: + property: + type: string + operator: + type: string + values: + type: array + items: {} + histogram: + type: object + properties: + property: + type: string + range: + type: string + enableEmptyInterval: + type: boolean + value: + type: string securitySchemes: - BearerAuth: + authKey: type: http - scheme: bearer - bearerFormat: JWT + scheme: Bearer ExternalTags: {}