Skip to content

SDP-1928: Update SDP API reference #2150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philipliu merged 4 commits into from
Jan 8, 2026
Merged

SDP-1928: Update SDP API reference #2150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b26524
Update SDP API reference
philipliu Dec 19, 2025
a0cd034
Update routes.txt
philipliu Jan 6, 2026
f22d97b
Add back generated route
philipliu Jan 6, 2026
eed9dc3
Remove APIs
philipliu Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .../platforms/stellar-disbursement-platform/api-reference/authenticate-mfa.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Governs the multi-factor authentication process for SDP user login
sidebar_label: "Provide Multi-Factor Authentication"
hide_title: true
hide_table_of_contents: true
api: eJzNV01z2zYQ/SsYnJIMKTqetAfe5I80bpPUEznTg+NxluRSRAQCDLC0rHr03zsLkhZlJXLSNjPRRRKweHj7sNhd3EmCuZfppZy2VKEhlQMpa+RVJAv0uVNN+JvK3+wNOuMFVSjqVpOKS8jJOgFbC0XjbI7ei9I6MTs5F61HJ7SdKxMJZXLdFsrMAwpkSitaCbLCYY11hi6MF3ijchTeijcvp0J5YSwJ0EtYeeHwc6scFhMZSdugC3ueFTKVIxr45uVURrIBBzUSOvbvThqoUabyJKDHZycykoodqxAKdPKhv2cFo5UKnbDliJeM5EBCpiVoj5H0tNKM7VXdaLbA20bbAjcGeYU1yPRO0qoJluSUmcv1+qqDQ09HtlixxTYNlqA3EAUQyEjm1hAaYttnyTP+2sBvqF3KuoTrnFlcRcO2NvuEObE2jtUjhZ5X3VvuEHyoyps9Jx8Q1uxPd5jX9Rgws1YjmB3Eo25clBrmO6HAwdNB5tBQXsE12QWax3lesFmIQYfH0/OL41dTcQNaFYHqRLy7Hw2AHGWDdKI1mgOY9/94cjabHr0+vX532tt/FLk1pZq3XejxQo/ExMm1OJFr/oxDhIfDgG+s8Z3ehwcHuyc9a3O+OGWrHwi7feTQNLqfSD55a7bPf/85f6N426mgU6hzbB3JF1/ifgSFeNdF6f/HFp2z7nG2J0igtBeQ2ZbCqXUL13wNyYF/dKfgF95CuLybjeWZCSEjlGlakmO4UqEurktrZbr5PQ4iGfXjGbh7mwycMIiF53DJUIARyhDOOcbv1X2+q+57wwFhnfo7AP9Yeb9dNukJqB3bmZZvLkPU6D3Mv5BQ1l8T+y0n+bGbGxbDPi8Ono+QH674kcAB+zbmDDdHE/cJOc5ssYr7usK/O3A0XlnTFZ0FrmS6d2Ukb0C39whcEGqkynJNa2y4Tw1QJVOZ1CWnf4/uZqhprdMylWGRx7x1ilYzPv7ufI4QHDq+zaNzgEb9gaudW/T7XxecbYuQM7fzTyS8mhssxFJRxUF7Ojv85VfROHUDhGKBK67GvQzTXrchc41LLIuoTGkDG0WhZM4ItQYnTpTPWuexRkPiXAOV1tVien7GAqHzHcvDyfPJAWvQ1jU4lvaiQrEf48ns5Pwp300QZK0WWas0BTetm4PpqYY7WcMCRdbqhWhgxShhFMTc2bbhNsBhrhoVJrgdCtlm2N0gLa1bTHZr0U9H8YP5YC4q5cOWRtgGText63Lk9o3vuqAKiKc7KqEKNEMj9AAuEmCKMMFRLnIwnNxK25oiLKz4j9Z2yY2fw8Z6RdYp9CnziMWl7/CS/jsuRiLFTS9SnEG+QFNcPamIGp8myVxR1WaT3NbJdyE8TUVw/p7Kims6geq7294seKVM6cCTa3NqXe8gnws9dqaT7/CsdCGj/xfXBojHfFtiJgbbf+1NhbqO8woc+b2UR3YJOcSkBmWSfmCvP4+58Qp1LQJQ4F9go+1qeFfsv2utZ7tFm6EzSOgnHzhNEbra/1nO0IUeP5WDWz3NiXXzJBjFtox9bxZJrXI0PtSbIQE2kFcoDkOe6vIzY6VJslwuJxBmA1q/1Cevz45P385O48PJwaSiWoc8yam/BjMCPnf2RhUouhb8ZdeCTx92ilup527TK/yE77e+IBHeUtJoUIYbh6DYXV/ywhuGny8VF8L0Ut7dZeDxvdPrNQ9/bpGLwOUVF1GnIOOScnm1joaKwzWyUJ4nNq+1r0q058n3Ra5dcR8/KIdSLtfRUPuPO/j4ghE2Fvxy2xhN8xwbGk3vNHZbfcH5n7MLGXUNAz/fwtNNOljy4xSWgcB6/Q9FjJ0S
api: eJzNV0tz2zYQ/isYnOIMKdoetwfe5Ecat0mqRs704HicJbkUEYEAA4CWVQ3/e2cB0pJsR05aZya6SAIWH759YB8r7mBmeXrJx62rUDmRgxNa8auIF2hzIxr/N+W/6Rs0yjJXIatb6URcQu60YbB1kDVG52gtK7Vh09MJay0aJvVMqIgJlcu2EGrmUSATUrglc5oZrLHO0Pj1Am9Ejsxq9vbVmAnLlHYM5AKWlhn80gqDxYhHXDdo/J3nBU/5Bg18+2rMI96AgRodGtJvxRXUyFN+6tHj81MecUGKVQgFGn5f3/OC0EqBhulygxeP+ECCpyVIixG3bikJ24q6kSSBt43UBa4F8gpr4OmKu2XjJZ0Rasa77irAoXXHuliSxDYNMkEvwApwwCOea+VQOZJ9mbykrzX8mtolr0u4zonFVTRcq7PPmDuyjSHrOYGWTt1JPiB43ypvd3jeI3SkT3Dmdb0JmGktEdQDxOOwzkoJswehQMETIHNoXF7BtdNzVE/zvCAxH4MGT8aTi5PXY3YDUhSe6oi9v1v1gBRlg+lYqyQFMN3/6fR8Oj5+c3b9/qyX/8RyrUoxa0Po0UGLjog70+KId/TZDBFa9gu20coGex/u7z/09LTN6eGUrbxn2G2XQ9PIfiP5bLXa9v9uP3+j8bZTQbBQUKyL+NFj3I+hYO9DlD4fWzRGm6fZnqIDIS2DTLfOey0c7OgZOgP2yZu6tW4HD3X7oMgd2oh/sPjhyn07aW4duHZTTrX0bgiiRmth9shzDmriLfg8tabB31GK3VRzzWK452j/YAP5/okfCeyxb2PKLzNUcZ8O40wXy7jP6vQ7gKOyQquQ8ue45OnOkxG/AdneIVA6rtFVmipKo300N+AqnvKkLin5WjQ3Q0VpjeQp94cs5q0Rbjkl9wf/HCMYNPSWNvwAjfgDl4++ONI3PLhQkSjROBCKyiUoX0t///uCvTibHv7y6x6j/OtXr9l4cs7muKSa2JtjC+9eoesiPj2bHOw/EzM2PZvEB/uBW9CZrXzK6Pa+i9Hh0XMyOjx6DkZ/tWiW30bLi7K7nuNrjDYIhLzaX/yFjnMKdKFK7a8TzjcVU4dSgmGnwmatsVijcmwiwZXa1OR7CmI0NtA4HB2M9ilO27oGQ+F/USHbjfFiejrZo0oGzGktWdYK6Xzx1GYGqjeRpSJXwxxZ1so5a2BJKH4V2MzotqFGyWAuGuE3qGH0+Xi4XaFbaDMfPazWPx3Fj+qjuqiE9VcqphtUsdWtyZEaXMrHzFXgaDtQ8XWyGVrFe3ARA1X4DcpELAfFMmSlblXhD1b0R0q9oGgx2GgrnDYCbUo8YnZpA17Sf8fFhpHipjdSnEE+R1Vcvaica2yaJDPhqjYb5bpOvgthL2Ve+TsqyyGcQ1vUi3mthCoNWGfa3LWmV5D84p7y6eg7NCuNr7r/R7UB4indFpixQfY/a1OhrOO8AuPsTsobcokziEkNQiX9wk59nlLjNcqaeSDPv8BG6uUwee1+a60luXmboVHo0I4+UpZyaGr7ZzlF46eglA9q9TRH2swSLxTrMra9WMSlyFFZ3xMMibeBvEJ26PNUqKGElSbJYrEYgd/1aP1Rm7w5Pzl7Nz2LD0f7o8rV0udJKs81qA3gidE3okAWhpRXYUgZ3++lt1LPat3P/YQTbl9xHN66pJEgFBUmb7FV35b4KY8GvIqalfSSr1YZWPxgZNfRcigr6eUVNTpGQEYl5fKqi4ZKR31MISxtrOfZr5pox1D8KNfQgG2O3EO7xbto6M9OAnx8QQhrCZpt10LjPMfGbWw/aL63erfJn9MLHoWmjgZcP9xyAwsa32HhCXTdvxve+X4=
sidebar_class_name: "post api-method"
info_path: docs/platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api
custom_edit_url: null
Expand Down Expand Up @@ -66,7 +66,7 @@ Governs the multi-factor authentication process for SDP user login, including th
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Details about the error"},"extras":{"type":"object","properties":{}}},"example":{"error":"Invalid input","extras":{"field_foo":"field_foo is required","field_bar":"field_bar needs to be an integer"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}
responses={{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Details about the error"},"extras":{"type":"object","properties":{}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}
>

</StatusCodes>
Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/stellar-disbursement-platform/api-reference/create-api-key.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Creates a new API Key to access SDP endpoints. API Key can be conf
sidebar_label: "Create API Key"
hide_title: true
hide_table_of_contents: true
api: eJzVWG1v2zYQ/isEP7WD/BKv3Yu+pU2GeRtWo04xYGkQnKSTxYUiVb7E9Qz99+EoyZaVFzddC2yfLJPHh3fH43N33HIHK8vjS366mLNfcWP5VcQztKkRlRNa8Zi/NggOLQOmcM1aOeY0gzRFa9nybMFQZZUWytnxTiAFxRJkqVa5WHmDGS0p4BYZsJUB5SUYZhCyydoIhy1axEBaHUBu9iAGrTMidQ2IK5DZClORi5TNF0wbZkCtkOk8zM0Xdswjris0QDbMs50Vp4v5r7jhETf4waN1r3S24fGWp1o5VI4+oaqkSMPCyV+WPLDlNi2wBPpymwp5zHXyF6auxREGM3KhghJ5xCs0pbBWaBWcWRlSxAm0tD7I7HHILLXiQ5f/7EtQI3IOJBIZLWK5NsG61jW8PtxpjwnGwOYO5G/COnJQb004hp1Phd1BR1w4LO19eqLyJdlKusUgJY94OL72OwxnwibeWCxRObsTGI4GUYMpils0e7H+SBCpYHMI1BsIAtqsQIm/w4nthAaDQdDb/kbdvzC1Bimxt8f+f5i2DpywTqS7EfxYaeMsv6ojXgo1b/x1UkccP1bCbK4zcPcedK5NCY7HnARGToSQOTyqN+EDJAtQwQRG0sMQYM9Kbx3dD6HCeO6dN/icQgOk1GvMrkUVjlErfJPz+PJY4C2FWkm6QQyyzNDt1oa9np+9bW4Yr6M7YfZAqNRD6FOSpwjcg+MA3vL6DvvMF7vbH2J24IMxm+dMaccqo29FhlkUZnvc4S1mLDe6ZKA2bL7gdR1xJ5zEASu8bSiB1ySwv9fOeAwDttLKNrd4Nj2hn4GBHWcFzIxZHxgt91KSnz6bYg4JRGTH6eOdEh88MpGhciIXaO4jjy/KRPRzFOuiIJZ3HuQ+grWSG2bQeaMwY1qlyMA1LhRaPT/Ocp8afk/hv7v3519u2qI9HvpfgjrOB4zRZsSeYW10XoP7zC3+KFAdsNAabBfz/Q2ST4iIdxYNWxd6d2cGyvoq+wrKSrCOtdD9XZ6kcR9kqDbNXRPvfBXFLWn9IIc1LEUkVkf8xXR6l6deQcba8oeN2C1IkTURg8bokBJ7VPXN5JunsFOAOO7FM3QgpGWQaO+Cmc3CcAecAXt0p2AefoSyktjbmM9VMIgJVXlatIfLBcrsOteax/tvJizbUX3UjidgdjIJGKYQM0skkSADxYRyuEITXNw4+Z5k8E6Bd4U24u8A/MU9+ume4lS8+L6c8mWCwdklWgure8imfsi/v2vHDizba9Ht82J60kMermiQ78uAX2u3cETf3j2in7RJRJah+irnc7/79ns+xQ0Hq2idxdQb4TahonuFYNCcelfw+PKKKqgSXaGp6am0DRoDzfEJVGJ0Qz0eIZhQZBOAN5LHPNReHfCSrG8M7MPvE2Elmj7q0KW//HHR1lvahGOgAqSxL2JWrCjHr4Ur6BqdL2cvv2OVEbeUqKiU411Rwk/bE+zKd0HgBUIWrl3EyVdv9x3c+d5lLcCOdw6Kh17bcjXItnw2nb0YTb8fzX68OHkZvzyJZz+Mp9+f/MkHtUDvAgqV6+CTloiXDiU1tWe9ToctJDjieyJyHnFyeuOr2fhkPKWT8GUJZtPWR49jPFueLZ4TZwFzWkuWeCFdcHa/3wlcVcINssTLG9b1S6FlZyujfUV1gcFUVCJM6FtsKrpud4Vurc3N+N4S7r+l4nv1Xl1Q8UZbKqYrVCOrvUmRWgK6sswV4Gi6UUUr5nTVVUYDuIiBatJ5qjPsWohce5WFhdRkaQoHoVbMYKWtcNoItDHpMWKXtsGbtL+jftc7qlonjRJIb1BlV88K5yobTyYr4QqfjFNdTp6E8DxmwfidKht6cHEgyMMFslYsWCVUbsA641PqEhsDu1L+0TMdP8Gy3AQm/TemdRDHbFtjwjrZz7amQFmO0gKMs4+q3JObOIM4KUGoSTvwqD3HzPgZZckCUNA/w0rqDYXXUUuYtyR34xM0Ch3a8XsiS4emtG/yJZpbkRIvdWa1ao61WU2C0EjnI9uKRVyKFKl03LPoaQVpgWwWeKrJEoQVTybr9XoMYTagtUvt5Lf56/Pfl+ej2Xg6LlwpA1tTFipB9YCbkrV7KhyyTO857n/7+NjmSYcf3aSSIFRoNMiF2zYdX/JdOr6KeEGZOr7k220CFt8ZWdc0/MEjpYbLq4jfghHUg4ckH3XZkPJ3aL7568ZnowvamcSlbzL1oMSgJ5xmxWmaYuUele0XE4s3ywse8aR9Mi11RmsMrOlNDNZUQtCjq+sa9TC25RLUyjfFWYMZCp875UTz7th+9B6qQG16Gg4Lg8aQpu16YMl22xQrdb2Tb6YeXNG6tpOms7uq6/ofTv4Wzg==
api: eJzVWNtuGzcQ/RWCTzGwutbpRW9O7CJqi0aNHBSoYxij3ZGWMZfc8GJFFfbfiyF3pfX6ojh1gNYvWpPDw5nh8PCQW+5gZfnkgp/MpuxX3Fh+mfAMbWpE6YRWfMJfGwSHlgFTuGa1HXOaQZqitWx+OmOoslIL5Wx/Z5CCYgtkqVZLsfIGMxqSww0yYCsDykswzCBkg7URDmu0hIG0OoBc70EMWmdE6iKIy5HZElOxFCmbzpg2zIBaIdPL0Ded2T5PuC7RAMUwzXZRnMymv+KGJ9zgJ4/WvdLZhk+2PNXKoXL0CWUpRRoGDj5aysCW2zTHAujLbUrkE64XHzF1NY4wmFEKFRTIE16iKYS1QquQzNKQI06gpfHBZo9DYakV76b8jS9A9Sg5sJDIaBBbahOiq1PDq9sz7THBGNjcgfxNWEcJao0Jy7DLqbA76IQLh4W9z09UvqBYybcJSMkTHpav/g7NmbALbywWqJzdGXRbg6nBFMUNmr1ZuyWYlLC5DdRqCAbarECJv8OK7Yw6jcHQ2/ZEzX+haw1SYmuO/f+h2zpwwjqR7lrwc6mNs/yySngh1DTma1QlHD+XwmyuMnD3LvRSmwIcn3Ay6DkRSub2Ur0NHyBZgAohMLLulgB7UXjraH8IFdqX3nmDR1QaIKVeY3YlyrCMWuHbJZ9cHCq8uVArSTuIQZYZ2t3asNfT03dxh/EquVNmD5RK1YU+IXuqwD04duAtr+6wz3S22/2hZjs56LPpkintWGn0jcgwS0Jvizu8xYwtjS4YqA2bznhVJdwJJ7HDCu8iJfCKDPb72hmPocGWWtm4i8fDEf10Amw4K2BmzPrAaEsvJeXpqynmNoGI7DB9vFfik0cmMlROLAWa+8jjWZmIfg5inefE8s6D3FewVnLDDDpvFGZMqxQZuJhCodXRYZb70vJ7Cv/d3T//ctIa7fHSfw7qOOswRn0itgKrq/MK3FdO8WeO6hYLrcE2Nd+eYPEFFfHeomHrXO/2TMdZX2bfwFkJ1rEauj3Lkzxug3Tdpr4r4p1v4rglrx/ksMhSRGJVwo+Hw7s89QoyVssf1mM3IEUWKwaN0eFIfCaqCniHU3qKDoS0DBbauxBzHBg2hDNgD85UxT+K9x5efq/Au1wb8Tdm3zy4L3eak6jwbTvliwWGuAu0Flb3kEAdJ36GopTY8oP/rh27FefejWai4+GoBd0dsUvhd3dT+LM2C5FlqL59/h4Ib+9B7afF1BvhNkHUvEIwaE68y/nk4pJERIEu16T7S23D5EB9fACl6F3TNYcQTNCZBOCN5BMe5EcDPKdAoq9t+P1ZUIp4leiogDqjcUvlCBkaugQ5EEqoFQMVLky//HnOXpzNxy+/P6KDILZe7VQNb87n23h09NAkEZYqZX42Gw2fyTM2P5v1RsPoW4yZbZ2+RlUdPcmj8fFzejQ+fg6P/vBoNl/mVjBlJRgo0D3sUcuB4FIz8ScaHhia9sS7/UXzbF/W9bgdI97SOK3b1WVHFPDxcHzcG/7QG/90Pno5eTmajH/sD38Y/cU7kqXFR0ItdQi6Pi/mDiXdvU9bFzI2k+DoWKIK5AmnjRGTMe6P+kPaLb4owGxqGfc4xov56eyICXoycFpLtvBCuiAb29cyS7qrgGtkCy+vWXOtCy8LbGW0L0m+GExFKUKHvsEoPJvZFbq1Ntf9e5Xmf8vFD+qDOieNSVMqpktUPau9SZFuLsSQzOXgqDu6ohVzumwEXAcuYaCi6kh1hs1NZ6m9ysJAugtqKgeqWYOltsJpI9BOyI8eu7ARb1D/9tqX815ZJ6m3gPQaVXb5IneutJPBYCVc7hf9VBeDJyEcTVgIfufKptlUNjhbm4WohFoasM74lC6zMcDmxvHomvafENnShFPs34TWQByKbY0L1th+dTQ5yqKX5mCcfdTllt3AGcRBAUIN6oZH4zkUxhuUBQtAwf8MS6k3VF4HI2Hekt21X6BR6ND2PxBXOjSFfbuco7kRKfFSE1btZl+b1SAY9fSyZ2uzhEuRIincPYuelJDmyMaBp+JJTliTwWC9Xvch9Aa0eqgd/DZ9ffb7/Kw37g/7uStkYGtSCgWoFnBU1s2LZpdlWq+G/9s30vogdPjZDUoJQoX7EKVwW0umC76TTJcJz0lNTS74drsAi++NrCpqjkfe5OIy4TdgBD0VBCGWNKcwaazwRsBfx5z1zmlmMpc+HsUdKUkvTXHESZpi6R61bQu+2dv5OU/4on7ZLXRGYwys6ekO1iTz6G3YNe8JoW3LJaiVj8I4YlJJwB29EJ9H64/WexqoTcvDriCJgcTb4QNDttuoRqpqZx+7HhxRp7axprW7rKrqH37/S94=
sidebar_class_name: "post api-method"
info_path: docs/platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api
custom_edit_url: null
Expand Down Expand Up @@ -66,7 +66,7 @@ Creates a new API Key to access SDP endpoints. API Key can be configured to have
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"API key created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the API key"},"name":{"type":"string","description":"Human-readable name for the API key"},"key":{"type":"string","description":"The actual API key (only returned once at creation)"},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permissions granted to this API key"},"allowed_ips":{"type":"array","items":{"type":"string"},"description":"List of allowed IP addresses or CIDR ranges"},"expiry_date":{"type":"string","format":"date-time","description":"Expiration date of the API key"},"created_at":{"type":"string","format":"date-time","description":"When the API key was created"},"created_by":{"type":"string","description":"User who created the API key"},"updated_at":{"type":"string","format":"date-time","description":"When the API key was last updated"},"updated_by":{"type":"string","description":"User who last updated the API key"},"last_used_at":{"type":"string","format":"date-time","description":"When the API key was last used"}},"title":"CreateAPIKeyResponse"}}}},"400":{"description":"Bad request - validation errors","content":{"*/*":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Details about the error"},"extras":{"type":"object","properties":{}}},"example":{"error":"Invalid input","extras":{"field_foo":"field_foo is required","field_bar":"field_bar needs to be an integer"}}}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}},"application/json":{"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"example":{"error":"Forbidden"}}},"application/json":{"example":{"error":"Forbidden"}}}}}}
responses={{"201":{"description":"API key created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the API key"},"name":{"type":"string","description":"Human-readable name for the API key"},"key":{"type":"string","description":"The actual API key (only returned once at creation)"},"permissions":{"type":"array","items":{"type":"string"},"description":"List of permissions granted to this API key"},"allowed_ips":{"type":"array","items":{"type":"string"},"description":"List of allowed IP addresses or CIDR ranges"},"expiry_date":{"type":"string","format":"date-time","description":"Expiration date of the API key"},"created_at":{"type":"string","format":"date-time","description":"When the API key was created"},"created_by":{"type":"string","description":"User who created the API key"},"updated_at":{"type":"string","format":"date-time","description":"When the API key was last updated"},"updated_by":{"type":"string","description":"User who last updated the API key"},"last_used_at":{"type":"string","format":"date-time","description":"When the API key was last used"}},"title":"CreateAPIKeyResponse"}}}},"400":{"description":"Bad request - validation errors","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Details about the error"},"extras":{"type":"object","properties":{}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}},"example":{"error":"Forbidden"}}}}}}
>

</StatusCodes>
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/stellar-disbursement-platform/api-reference/create-asset.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "This endpoint is used to create a new asset that can be used in a
sidebar_label: "Create Asset"
hide_title: true
hide_table_of_contents: true
api: eJzVVk1T20gQ/Stdc0qqJIsQEqp0Mxg2bFggMQm1a3wYSW1rYmlGmQ8bRaX/vtUjCcxHyGZz2eVg7Jnu191vevpNwyxfGhbP2Llecim+cSuUZPOAZWhSLSr/M2aXuTCAMquUkBaEAWcwA6sg1cgtAgeJG+DGoAWbcwspl5BgZyYkcJgIkzhtsERpR3CmLMZgcwS1FRdKZyzkqsiAQ8ILLlPsvCuurUhdwfUQRBE2CNvtZ9voLGCqQu0hTzIWs0Of5JgcWcA0fnVo7IHKahY3DwodD+gJ9rVlLGCpkhalJXNeVYVIPXb0xZBPw0yaY8npG2ELjRkxmqoMWcCEMQ41UWrrClnMVPIFU0qk0pSmFWjI1ZvHzWBlrBZyyR4fBPYM9PB4w8uqII9P08kha28D/iOo3nYb5reDg8ne/snx29Or9/sX+39Mjj5PD68+7k8uPl19fn325+vJ5Yejz8ene2fjy73xh3ev/zo9PT4dv2Et/QVbFFjt0C+YSknTVbm78+p7pPd0g3FpisYsXFHU97gn9L2dncf+BzyD/lQDEHLNC3G7AInKalDaN1ul1VpkmHnyoq546ubeZ/QgXBswg6nTwtYsnjXsALlGPXY2Z/Fs3s4DdhMS0hJl2IcLKVwoeUlU0nfPrUVphJLGo6ywZvGzngFb88LdIlCgEm2uqJcrZXzvcEqCRb4XDKNE9Rp1F8HpgsXM+w35T6lFuyPYruK2R3gl3mP9qEd+v7rs7vBCaeDO5iht3/0BGLGUmMFG2By4hKPp7pu3UGmxpomwwpro7JmgaEoP4yVggsBz5BlqRjTTTfp4dy+Phm4crkXX3He9/QtdSsEXypcurO/4qcWCJsv2iIKLgtuF0iWML07oQFCbjpLd0avRDhHuypLrur9Iz2O8mE4uXlKjcbBKFZA4UVjP6fb4MzR3Sr5CSFyxgorXhOJXOSy1chWoBWhMRSX8hlpj19dDdIl2o/Rq9ORd/2+leC2vpVcVCilBVShDo5xO/S2lCdkJiTB9KkqCVR7+CbgAuMz8BvXLoD4L5WTmHXP6URRqI+QSNFbKCKu0QBNTHiHMTIcX9f/DbUEJq56kMOHpCmU2f5FbW5k4ipbC5i4ZpaqMfgrhZQy++NtUaqDBwwUxnCP0Zr4qIReaG6tdap3uC1yo+6w+eaajn6hsof3c+5XSBogf1bbBBAbbf11NjkUZpjnX1jyb8pZdZDViVHIho37h2Xp+VMY7LErwQD7/DKtC1dReP6wEnCG7lUtQS7RoRtc0Ey3q0pwvpqjXIqW5NJTVpzlSehl5o1AtQtObBawQKUrjh+UwbSue5gi7fk51YkBYcRRtNpsR97serXc10enJ4dHZ9CjcHe2MclsWfiiT1JRcbgF3DykYXlL3ZkxzJ53/u+diL4IWb2xUFVxIkglPXNMr7Yz1SjsPWE4SHM9Y0yTc4CddtC0tf3VIcjCbk3xrwRMSl9m8DQahuxP/w46p8JLi3qn9o7flPeW/OJ9esqB7EsQNKzth1HxDb1q+IcWnh6/tHhpNt9awgsul40uy7TDpaPkj9V959e+/UKbDlqy3Mnyo41059NkG33Fpmu5t0ba39t3Wdz16ugZrOo1527Z/AxqDc2E=
api: eJzVV1Fz2zYM/is4PjV3kuW4aXOnNyd216xZ6tZpc5vr29ESbLGWSI2k4mo6/fcdSClxmiZt1z5sfrBlEvjwAQQBqGGWbwyLF+y13nAp/uZWKMmWAUvRJFqU7m/MLjNhAGVaKiEtCAOVwRSsgkQjtwgcJO6AG4MWbMYtJFzCCr2YkMBhIsyq0gYLlHYAF8piDDZDUHt2oaiMhUzlKXBY8ZzLBL12ybUVSZVz3RtRhA3C+v10H50FTJWoHeRZymJ26kiOSZEFTONfFRp7otKaxc1njo579BV2vqUsYImSFqUlcV6WuUgcdvTRkE7DTJJhwemJsIXGlCKaqBRZwIQxFWoKqa1LZDFTq4+YEJFSE00r0JCqE4+bXspYLeSG3T8I7CLQweMnXpQ5abybT05Ze2Pwm6A62X2YX05OJkfHZy+en1+9Op4d/zaZvp+fXr09nszeXb1/evH708nlm+n7F+dHF+PLo/Gbl0//OD9/cT5+xlr6BHshsLpCt2BKJY33cjQ8fCjoXbjBVEmCxqyrPK/vxJ7Qj4bD+/onPIXuVAMQ8prn4mYBViqtQWmXbKVW1yLF1AUv8s5TNnc6g8/MtQEzmFRa2JrFi4adINeox5XNWLxYtsuAfQoJaYMy7MyFZC6UvKBQ0rOLrUVphJLGoWyxZvGjmgG75nl1g0CGCrSZolwulXG5w4kEi1wuGEZE9TVqb6HSOYuZ0+v5zylF/RHse3GTI7wUr7C+lyMkpXR/PTPkKWqgEHEhhdwAlzCfzODXq0t4Mp2Pnj0/oFD71T9hPDuDLdYU1i4id/DocpARD0upO5/ODoc/iRnMp7PwcOi5eZ+hsWqLsj34Lkajo5/JaHT0Mxi9qVDX30bLiVIB5QXahxntEXCUesN/kTqjq0DV7u1t7Zz2FaMvXb4A3dafH6gkZHutnG/Cuqo0t5hT9d9vIzDLuV0rXVCi0aVBbbzPo8HhYEiXoioKruuu2D2O8WQ+mR1QMeBglcphVYncwlrpOy3KUG8o+BZhVeVbKHlNKG6Vw0arqgS1Bo2JKIXbUNfoa09vXaLdKb0dfLEe/7cofpAfpOv8ZFKCKlGGRlU6cZWUuphv9sJ0VJQEqxz8F+AC4DJ1G5Qv/YSwVpVMnWJGf/Jc7Sg1NZbKCKu0QBMTjxAWxuNF3W+43/TDsgtSuOLJFmW6fJJZW5o4ijbCZtVqkKgi+i6Egxic8zdU6v7uGEe2E3NeCbnW3FhdJbbSnYNrdTeqXzzTwXd4ttauN/2Iaz3E13zb4Qp62X/tTYZ5ESYZ19Y8SnlPLrIaMSq4kFG38Kg/X3PjJeYFOCDHP8UyVzWl11c9gcqQ3LZaoZZo0Qw+UEm0qAvzej1HfS0Sqku9Wx3NgdKbyAmFah2aTixguUhQGlcs+ypf8iRDGLk65Rs2YcVRtNvtBtztOrRO1UTnZ6fTi/k0HA2Gg8wWuSvKNA4UXO4B+2EX+mn3To1pbseb/91I33U5i59sVOZcSGoTLnBNNw0tWDcNLQOW0ZgUL1jTrLjBdzpvW1r23SxeLGnE0oKvqLkslm3QN9jbAe3URyq8JLu3E9m9+f/OdDZ7Pb9kgR/b4oYVvjFqvqP3Dr6jqYxeTqwfBhu/1rCcy03FNyTrMelo+b32vnXtvXsgpv2WrPcYfj4/eHfouw0eUGkaPzy07Y2833pQowtXL02nsWzb9h/gaP1Y
sidebar_class_name: "post api-method"
info_path: docs/platforms/stellar-disbursement-platform/api-reference/stellar-disbursement-platform-api
custom_edit_url: null
Expand Down
Loading