848 lines
289 KiB
HTML
848 lines
289 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<meta charset="utf8" />
|
||
|
|
<title>vStash S3 Compatible API</title>
|
||
|
|
<!-- needed for adaptive design -->
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<style>
|
||
|
|
body {
|
||
|
|
padding: 0;
|
||
|
|
margin: 0;
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
<script src="https://cdn.redocly.com/redoc/v2.5.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.18">.iRoSfe{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.iRoSfe{width:100%;padding:40px 40px;}}/*!sc*/
|
||
|
|
.ciCSbi{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.ciCSbi{width:100%;padding:0px 40px;}}/*!sc*/
|
||
|
|
data-styled.g4[id="sc-gwsNht"]{content:"iRoSfe,ciCSbi,"}/*!sc*/
|
||
|
|
.kDuBQd{padding:40px 0;}/*!sc*/
|
||
|
|
.kDuBQd:last-child{min-height:calc(100vh + 1px);}/*!sc*/
|
||
|
|
.kDuBQd>.kDuBQd:last-child{min-height:initial;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.kDuBQd{padding:0;}}/*!sc*/
|
||
|
|
.dRVblm{padding:40px 0;position:relative;}/*!sc*/
|
||
|
|
.dRVblm:last-child{min-height:calc(100vh + 1px);}/*!sc*/
|
||
|
|
.dRVblm>.dRVblm:last-child{min-height:initial;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.dRVblm{padding:0;}}/*!sc*/
|
||
|
|
.dRVblm:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0, 0, 0, 0.2);}/*!sc*/
|
||
|
|
data-styled.g5[id="sc-dYOLZc"]{content:"kDuBQd,dRVblm,"}/*!sc*/
|
||
|
|
.kCcXaS{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.kCcXaS{width:100%;padding:40px 40px;}}/*!sc*/
|
||
|
|
data-styled.g6[id="sc-jMpmlX"]{content:"kCcXaS,"}/*!sc*/
|
||
|
|
.jpPJrn{background-color:#263238;}/*!sc*/
|
||
|
|
data-styled.g7[id="sc-hoLldG"]{content:"jpPJrn,"}/*!sc*/
|
||
|
|
.tMeMv{display:flex;width:100%;padding:0;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.tMeMv{flex-direction:column;}}/*!sc*/
|
||
|
|
data-styled.g8[id="sc-jZhnRx"]{content:"tMeMv,"}/*!sc*/
|
||
|
|
.dKykVD{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
|
|
data-styled.g9[id="sc-hBDmJg"]{content:"dKykVD,"}/*!sc*/
|
||
|
|
.jkwlQD{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
|
||
|
|
data-styled.g10[id="sc-kThouk"]{content:"jkwlQD,"}/*!sc*/
|
||
|
|
.fHsMSp{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.27em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
|
|
data-styled.g11[id="sc-dTdQuR"]{content:"fHsMSp,"}/*!sc*/
|
||
|
|
.fdkIVZ{color:#ffffff;}/*!sc*/
|
||
|
|
data-styled.g12[id="sc-llIIlC"]{content:"fdkIVZ,"}/*!sc*/
|
||
|
|
.eUkINt{border-bottom:1px solid rgba(38, 50, 56, 0.3);margin:1em 0 1em 0;color:rgba(38, 50, 56, 0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
|
||
|
|
data-styled.g13[id="sc-elFkmj"]{content:"eUkINt,"}/*!sc*/
|
||
|
|
.jOWzfS{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
|
|
.jOWzfS:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
|
|
h1:hover>.jOWzfS::before,h2:hover>.jOWzfS::before,.jOWzfS:hover::before{visibility:visible;}/*!sc*/
|
||
|
|
data-styled.g14[id="sc-kieALA"]{content:"jOWzfS,"}/*!sc*/
|
||
|
|
.bnalXq{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
|
|
.gsIrbT{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
|
|
.dpIKEE{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
|
|
.dpIKEE polygon{fill:#1d8127;}/*!sc*/
|
||
|
|
.NOyYc{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
|
||
|
|
.NOyYc polygon{fill:white;}/*!sc*/
|
||
|
|
.eVNtOe{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
|
||
|
|
data-styled.g15[id="sc-dibcMh"]{content:"bnalXq,gsIrbT,dpIKEE,NOyYc,eVNtOe,"}/*!sc*/
|
||
|
|
.cDFxGr{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.cDFxGr{display:block;overflow:hidden;}}/*!sc*/
|
||
|
|
tr:first-of-type>.cDFxGr,tr.last>.cDFxGr{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
|
||
|
|
tr:first-of-type>.cDFxGr{background-image:linear-gradient(
|
||
|
|
to bottom,
|
||
|
|
transparent 0%,
|
||
|
|
transparent 22px,
|
||
|
|
#7c7cbb 22px,
|
||
|
|
#7c7cbb 100%
|
||
|
|
);}/*!sc*/
|
||
|
|
tr.last>.cDFxGr{background-image:linear-gradient(
|
||
|
|
to bottom,
|
||
|
|
#7c7cbb 0%,
|
||
|
|
#7c7cbb 22px,
|
||
|
|
transparent 22px,
|
||
|
|
transparent 100%
|
||
|
|
);}/*!sc*/
|
||
|
|
tr.last+tr>.cDFxGr{border-left-color:transparent;}/*!sc*/
|
||
|
|
tr.last:first-child>.cDFxGr{background:none;border-left-color:transparent;}/*!sc*/
|
||
|
|
data-styled.g18[id="sc-kHNKno"]{content:"cDFxGr,"}/*!sc*/
|
||
|
|
.kNAbAx{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
|
||
|
|
.kNAbAx.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
|
||
|
|
data-styled.g20[id="sc-frmfij"]{content:"kNAbAx,"}/*!sc*/
|
||
|
|
.dzPbxx{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
|
||
|
|
tr.expanded .dzPbxx{border-bottom:none;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.dzPbxx{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last>.dzPbxx{border-left:none;}}/*!sc*/
|
||
|
|
data-styled.g21[id="sc-groBii"]{content:"dzPbxx,"}/*!sc*/
|
||
|
|
.lhCIDE{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
|
||
|
|
.lhCIDE::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
|
||
|
|
.lhCIDE::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
|
||
|
|
data-styled.g22[id="sc-hLyRwt"]{content:"lhCIDE,"}/*!sc*/
|
||
|
|
.cGiuNU{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
|
||
|
|
.cGiuNU >tr{vertical-align:middle;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.cGiuNU{display:block;}.cGiuNU >tr,.cGiuNU >tbody>tr{display:block;}}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.cGiuNU td{float:left;width:100%;}}/*!sc*/
|
||
|
|
.cGiuNU .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
|
||
|
|
.cGiuNU .sc-iLBnws .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws,.cGiuNU .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws .sc-iLBnws{background:#ffffff;}/*!sc*/
|
||
|
|
data-styled.g24[id="sc-eGjrzz"]{content:"cGiuNU,"}/*!sc*/
|
||
|
|
.dFpYBv >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0, 0, 0, 0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li.tab-success{color:#1d8127;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li.tab-info{color:#87ceeb;}/*!sc*/
|
||
|
|
.dFpYBv >ul >li.tab-error{color:#d41f1c;}/*!sc*/
|
||
|
|
.dFpYBv >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
|
||
|
|
.dFpYBv >.react-tabs__tab-panel>div,.dFpYBv >.react-tabs__tab-panel>pre{padding:20px;margin:0;}/*!sc*/
|
||
|
|
.dFpYBv >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
|
||
|
|
data-styled.g30[id="sc-cTIdZS"]{content:"dFpYBv,"}/*!sc*/
|
||
|
|
.kOqeZB code[class*='language-'],.kOqeZB pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
|
||
|
|
@media print{.kOqeZB code[class*='language-'],.kOqeZB pre[class*='language-']{text-shadow:none;}}/*!sc*/
|
||
|
|
.kOqeZB pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
|
||
|
|
.kOqeZB .token.comment,.kOqeZB .token.prolog,.kOqeZB .token.doctype,.kOqeZB .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
|
||
|
|
.kOqeZB .token.punctuation{opacity:0.7;}/*!sc*/
|
||
|
|
.kOqeZB .namespace{opacity:0.7;}/*!sc*/
|
||
|
|
.kOqeZB .token.property,.kOqeZB .token.tag,.kOqeZB .token.number,.kOqeZB .token.constant,.kOqeZB .token.symbol{color:#4a8bb3;}/*!sc*/
|
||
|
|
.kOqeZB .token.boolean{color:#e64441;}/*!sc*/
|
||
|
|
.kOqeZB .token.selector,.kOqeZB .token.attr-name,.kOqeZB .token.string,.kOqeZB .token.char,.kOqeZB .token.builtin,.kOqeZB .token.inserted{color:#a0fbaa;}/*!sc*/
|
||
|
|
.kOqeZB .token.selector+a,.kOqeZB .token.attr-name+a,.kOqeZB .token.string+a,.kOqeZB .token.char+a,.kOqeZB .token.builtin+a,.kOqeZB .token.inserted+a,.kOqeZB .token.selector+a:visited,.kOqeZB .token.attr-name+a:visited,.kOqeZB .token.string+a:visited,.kOqeZB .token.char+a:visited,.kOqeZB .token.builtin+a:visited,.kOqeZB .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
|
||
|
|
.kOqeZB .token.property.string{color:white;}/*!sc*/
|
||
|
|
.kOqeZB .token.operator,.kOqeZB .token.entity,.kOqeZB .token.url,.kOqeZB .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
|
||
|
|
.kOqeZB .token.atrule,.kOqeZB .token.attr-value,.kOqeZB .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
|
||
|
|
.kOqeZB .token.regex,.kOqeZB .token.important{color:#e90;}/*!sc*/
|
||
|
|
.kOqeZB .token.important,.kOqeZB .token.bold{font-weight:bold;}/*!sc*/
|
||
|
|
.kOqeZB .token.italic{font-style:italic;}/*!sc*/
|
||
|
|
.kOqeZB .token.entity{cursor:help;}/*!sc*/
|
||
|
|
.kOqeZB .token.deleted{color:red;}/*!sc*/
|
||
|
|
data-styled.g32[id="sc-faJlkc"]{content:"kOqeZB,"}/*!sc*/
|
||
|
|
.itwxyW{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
|
||
|
|
.itwxyW:focus-within{opacity:1;}/*!sc*/
|
||
|
|
.itwxyW >button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
|
||
|
|
.itwxyW >button :hover,.itwxyW >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
|
||
|
|
data-styled.g33[id="sc-VILhF"]{content:"itwxyW,"}/*!sc*/
|
||
|
|
.dkdAtf{position:relative;}/*!sc*/
|
||
|
|
data-styled.g37[id="sc-epGxBs"]{content:"dkdAtf,"}/*!sc*/
|
||
|
|
.iFdOsg{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
|
||
|
|
data-styled.g41[id="sc-edaYAx"]{content:"iFdOsg,"}/*!sc*/
|
||
|
|
.kEOvim{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
||
|
|
.kEOvim p:last-child{margin-bottom:0;}/*!sc*/
|
||
|
|
.kEOvim h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
||
|
|
.kEOvim h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
|
|
.kEOvim code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
||
|
|
.kEOvim pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
||
|
|
.kEOvim pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
||
|
|
.kEOvim pre code:before,.kEOvim pre code:after{content:none;}/*!sc*/
|
||
|
|
.kEOvim blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
||
|
|
.kEOvim img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
||
|
|
.kEOvim ul,.kEOvim ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
||
|
|
.kEOvim ul ul,.kEOvim ol ul,.kEOvim ul ol,.kEOvim ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
||
|
|
.kEOvim table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
||
|
|
.kEOvim table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
||
|
|
.kEOvim table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
||
|
|
.kEOvim table th,.kEOvim table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
||
|
|
.kEOvim table th{text-align:left;font-weight:bold;}/*!sc*/
|
||
|
|
.kEOvim .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
|
|
.kEOvim .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
|
|
.kEOvim h1:hover>.share-link::before,.kEOvim h2:hover>.share-link::before,.kEOvim .share-link:hover::before{visibility:visible;}/*!sc*/
|
||
|
|
.kEOvim a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
|
|
.kEOvim a:visited{color:#32329f;}/*!sc*/
|
||
|
|
.kEOvim a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
|
|
.kkltVg{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
||
|
|
.kkltVg p:last-child{margin-bottom:0;}/*!sc*/
|
||
|
|
.kkltVg p:first-child{margin-top:0;}/*!sc*/
|
||
|
|
.kkltVg p:last-child{margin-bottom:0;}/*!sc*/
|
||
|
|
.kkltVg p{display:inline-block;}/*!sc*/
|
||
|
|
.kkltVg h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
||
|
|
.kkltVg h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
|
|
.kkltVg code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
||
|
|
.kkltVg pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
||
|
|
.kkltVg pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
||
|
|
.kkltVg pre code:before,.kkltVg pre code:after{content:none;}/*!sc*/
|
||
|
|
.kkltVg blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
||
|
|
.kkltVg img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
||
|
|
.kkltVg ul,.kkltVg ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
||
|
|
.kkltVg ul ul,.kkltVg ol ul,.kkltVg ul ol,.kkltVg ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
||
|
|
.kkltVg table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
||
|
|
.kkltVg table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
||
|
|
.kkltVg table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
||
|
|
.kkltVg table th,.kkltVg table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
||
|
|
.kkltVg table th{text-align:left;font-weight:bold;}/*!sc*/
|
||
|
|
.kkltVg .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
|
|
.kkltVg .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
|
|
.kkltVg h1:hover>.share-link::before,.kkltVg h2:hover>.share-link::before,.kkltVg .share-link:hover::before{visibility:visible;}/*!sc*/
|
||
|
|
.kkltVg a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
|
|
.kkltVg a:visited{color:#32329f;}/*!sc*/
|
||
|
|
.kkltVg a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
|
|
.csbUjU{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
|
||
|
|
.csbUjU p:last-child{margin-bottom:0;}/*!sc*/
|
||
|
|
.csbUjU p:first-child{margin-top:0;}/*!sc*/
|
||
|
|
.csbUjU p:last-child{margin-bottom:0;}/*!sc*/
|
||
|
|
.csbUjU h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
|
||
|
|
.csbUjU h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
|
||
|
|
.csbUjU code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
|
||
|
|
.csbUjU pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
|
||
|
|
.csbUjU pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
|
||
|
|
.csbUjU pre code:before,.csbUjU pre code:after{content:none;}/*!sc*/
|
||
|
|
.csbUjU blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
|
||
|
|
.csbUjU img{max-width:100%;box-sizing:content-box;}/*!sc*/
|
||
|
|
.csbUjU ul,.csbUjU ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
|
||
|
|
.csbUjU ul ul,.csbUjU ol ul,.csbUjU ul ol,.csbUjU ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
|
||
|
|
.csbUjU table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
|
||
|
|
.csbUjU table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
|
||
|
|
.csbUjU table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
|
||
|
|
.csbUjU table th,.csbUjU table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
|
||
|
|
.csbUjU table th{text-align:left;font-weight:bold;}/*!sc*/
|
||
|
|
.csbUjU .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
|
||
|
|
.csbUjU .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
|
||
|
|
.csbUjU h1:hover>.share-link::before,.csbUjU h2:hover>.share-link::before,.csbUjU .share-link:hover::before{visibility:visible;}/*!sc*/
|
||
|
|
.csbUjU a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
|
|
.csbUjU a:visited{color:#32329f;}/*!sc*/
|
||
|
|
.csbUjU a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
|
|
data-styled.g42[id="sc-fdduAw"]{content:"kEOvim,kkltVg,csbUjU,"}/*!sc*/
|
||
|
|
.fbuMAW{display:inline;}/*!sc*/
|
||
|
|
data-styled.g43[id="sc-eINXvP"]{content:"fbuMAW,"}/*!sc*/
|
||
|
|
.indwFD{position:relative;}/*!sc*/
|
||
|
|
data-styled.g44[id="sc-fIQtvO"]{content:"indwFD,"}/*!sc*/
|
||
|
|
.iAOzgg:hover>.sc-VILhF{opacity:1;}/*!sc*/
|
||
|
|
data-styled.g49[id="sc-dRHutB"]{content:"iAOzgg,"}/*!sc*/
|
||
|
|
.eudsMA{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
|
||
|
|
.eudsMA .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
|
||
|
|
.eudsMA .callback-function{color:gray;}/*!sc*/
|
||
|
|
.eudsMA .collapser:after{content:'-';cursor:pointer;}/*!sc*/
|
||
|
|
.eudsMA .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
|
||
|
|
.eudsMA .ellipsis:after{content:' … ';}/*!sc*/
|
||
|
|
.eudsMA .collapsible{margin-left:2em;}/*!sc*/
|
||
|
|
.eudsMA .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
|
||
|
|
.eudsMA .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
|
||
|
|
.eudsMA .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:flex;align-items:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
|
||
|
|
.eudsMA .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
|
||
|
|
.eudsMA ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
|
||
|
|
.eudsMA li{position:relative;display:block;}/*!sc*/
|
||
|
|
.eudsMA .hoverable{display:inline-block;}/*!sc*/
|
||
|
|
.eudsMA .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
|
||
|
|
.eudsMA .collapsed>.collapsible{display:none;}/*!sc*/
|
||
|
|
.eudsMA .ellipsis{display:none;}/*!sc*/
|
||
|
|
.eudsMA .collapsed>.ellipsis{display:inherit;}/*!sc*/
|
||
|
|
data-styled.g50[id="sc-eRJQtA"]{content:"eudsMA,"}/*!sc*/
|
||
|
|
.caaBgn{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
|
||
|
|
data-styled.g51[id="sc-bFwXsg"]{content:"caaBgn,"}/*!sc*/
|
||
|
|
.TqlOY{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
|
||
|
|
data-styled.g52[id="sc-fUPiRJ"]{content:"TqlOY,"}/*!sc*/
|
||
|
|
.fpFYoG{position:relative;}/*!sc*/
|
||
|
|
data-styled.g53[id="sc-bXYrjy"]{content:"fpFYoG,"}/*!sc*/
|
||
|
|
.kuvBhH{margin-top:15px;}/*!sc*/
|
||
|
|
data-styled.g56[id="sc-bgpKpp"]{content:"kuvBhH,"}/*!sc*/
|
||
|
|
.fmWEAp.deprecated span.property-name{text-decoration:line-through;color:#707070;}/*!sc*/
|
||
|
|
.fmWEAp button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
|
||
|
|
.fmWEAp button:focus{font-weight:600;}/*!sc*/
|
||
|
|
.fmWEAp .sc-dibcMh{height:1.1em;width:1.1em;}/*!sc*/
|
||
|
|
.fmWEAp .sc-dibcMh polygon{fill:#666;}/*!sc*/
|
||
|
|
data-styled.g57[id="sc-iyUCga"]{content:"fmWEAp,"}/*!sc*/
|
||
|
|
.eyIabj{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
|
||
|
|
data-styled.g58[id="sc-byRegH"]{content:"eyIabj,"}/*!sc*/
|
||
|
|
.jGdyyu{color:rgba(102,102,102,0.9);}/*!sc*/
|
||
|
|
data-styled.g59[id="sc-budtlk"]{content:"jGdyyu,"}/*!sc*/
|
||
|
|
.fcQkkm{color:#666;}/*!sc*/
|
||
|
|
data-styled.g60[id="sc-fJvEKN"]{content:"fcQkkm,"}/*!sc*/
|
||
|
|
.iUhYwd{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
|
||
|
|
data-styled.g62[id="sc-isZTFa"]{content:"iUhYwd,"}/*!sc*/
|
||
|
|
.kRjrIj{color:#0e7c86;font-family:Courier,monospace;font-size:12px;}/*!sc*/
|
||
|
|
.kRjrIj::before,.kRjrIj::after{content:' ';}/*!sc*/
|
||
|
|
data-styled.g65[id="sc-cExZcH"]{content:"kRjrIj,"}/*!sc*/
|
||
|
|
.ewbVMc{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
|
||
|
|
+{margin-left:0;}/*!sc*/
|
||
|
|
data-styled.g66[id="sc-dEAvcG"]{content:"ewbVMc,"}/*!sc*/
|
||
|
|
.gqMqVY{border-radius:2px;background-color:rgba(104,104,207,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);}/*!sc*/
|
||
|
|
+{margin-left:0;}/*!sc*/
|
||
|
|
data-styled.g68[id="sc-fYNhqQ"]{content:"gqMqVY,"}/*!sc*/
|
||
|
|
.eSQudw:after{content:' and ';font-weight:normal;}/*!sc*/
|
||
|
|
.eSQudw:last-child:after{content:none;}/*!sc*/
|
||
|
|
.eSQudw a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
|
|
.eSQudw a:visited{color:#32329f;}/*!sc*/
|
||
|
|
.eSQudw a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
|
|
data-styled.g81[id="sc-hFPzkB"]{content:"eSQudw,"}/*!sc*/
|
||
|
|
.WPZDV{white-space:nowrap;}/*!sc*/
|
||
|
|
.WPZDV:after{content:' or ';white-space:pre;}/*!sc*/
|
||
|
|
.WPZDV:last-child:after,.WPZDV:only-child:after{content:none;}/*!sc*/
|
||
|
|
.WPZDV a{text-decoration:auto;color:#32329f;}/*!sc*/
|
||
|
|
.WPZDV a:visited{color:#32329f;}/*!sc*/
|
||
|
|
.WPZDV a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
|
||
|
|
data-styled.g82[id="sc-iFRVkA"]{content:"WPZDV,"}/*!sc*/
|
||
|
|
.gqqgtC{flex:1 1 auto;cursor:pointer;}/*!sc*/
|
||
|
|
data-styled.g83[id="sc-ilCyfT"]{content:"gqqgtC,"}/*!sc*/
|
||
|
|
.dNXpfB{width:75%;text-overflow:ellipsis;border-radius:4px;overflow:hidden;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.dNXpfB{margin-top:10px;}}/*!sc*/
|
||
|
|
data-styled.g84[id="sc-jlEUfS"]{content:"dNXpfB,"}/*!sc*/
|
||
|
|
.jefPco{display:inline-block;margin:0;}/*!sc*/
|
||
|
|
data-styled.g85[id="sc-gUMLBR"]{content:"jefPco,"}/*!sc*/
|
||
|
|
.iaIgja{width:100%;display:flex;margin:1em 0;flex-direction:row;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.iaIgja{flex-direction:column;}}/*!sc*/
|
||
|
|
data-styled.g86[id="sc-hUPhBQ"]{content:"iaIgja,"}/*!sc*/
|
||
|
|
.hLxGCH{margin-top:0;margin-bottom:0.5em;}/*!sc*/
|
||
|
|
data-styled.g92[id="sc-jxDJBN"]{content:"hLxGCH,"}/*!sc*/
|
||
|
|
.ierfVp::before{content:'|';display:inline-block;opacity:0.5;width:15px;text-align:center;}/*!sc*/
|
||
|
|
.ierfVp:last-child::after{display:none;}/*!sc*/
|
||
|
|
data-styled.g94[id="sc-jQfdtf"]{content:"ierfVp,"}/*!sc*/
|
||
|
|
.iZbnSR{overflow:hidden;}/*!sc*/
|
||
|
|
data-styled.g95[id="sc-exiKtA"]{content:"iZbnSR,"}/*!sc*/
|
||
|
|
.gMAaXs{display:flex;flex-wrap:wrap;margin-left:-15px;}/*!sc*/
|
||
|
|
data-styled.g96[id="sc-iMAVTd"]{content:"gMAaXs,"}/*!sc*/
|
||
|
|
.jXsdle{max-height:260px;max-width:260px;padding:2px;width:100%;display:block;}/*!sc*/
|
||
|
|
data-styled.g97[id="sc-ePKekS"]{content:"jXsdle,"}/*!sc*/
|
||
|
|
.bJrQmZ{text-align:center;}/*!sc*/
|
||
|
|
data-styled.g98[id="sc-jfcpKv"]{content:"bJrQmZ,"}/*!sc*/
|
||
|
|
.jMqrgI{display:inline-block;}/*!sc*/
|
||
|
|
data-styled.g99[id="sc-fdnRgs"]{content:"jMqrgI,"}/*!sc*/
|
||
|
|
.kfVmAL{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
|
||
|
|
.kfVmAL.get{background-color:#2F8132;}/*!sc*/
|
||
|
|
.kfVmAL.post{background-color:#186FAF;}/*!sc*/
|
||
|
|
.kfVmAL.put{background-color:#95507c;}/*!sc*/
|
||
|
|
.kfVmAL.options{background-color:#947014;}/*!sc*/
|
||
|
|
.kfVmAL.patch{background-color:#bf581d;}/*!sc*/
|
||
|
|
.kfVmAL.delete{background-color:#cc3333;}/*!sc*/
|
||
|
|
.kfVmAL.basic{background-color:#707070;}/*!sc*/
|
||
|
|
.kfVmAL.link{background-color:#07818F;}/*!sc*/
|
||
|
|
.kfVmAL.head{background-color:#A23DAD;}/*!sc*/
|
||
|
|
.kfVmAL.hook{background-color:#32329f;}/*!sc*/
|
||
|
|
.kfVmAL.schema{background-color:#707070;}/*!sc*/
|
||
|
|
data-styled.g100[id="sc-jsGcFV"]{content:"kfVmAL,"}/*!sc*/
|
||
|
|
.bquqCV{margin:0;padding:0;}/*!sc*/
|
||
|
|
.bquqCV:first-child{padding-bottom:32px;}/*!sc*/
|
||
|
|
.sc-FhnSQ .sc-FhnSQ{font-size:0.929em;}/*!sc*/
|
||
|
|
.jtzvEg{margin:0;padding:0;display:none;}/*!sc*/
|
||
|
|
.jtzvEg:first-child{padding-bottom:32px;}/*!sc*/
|
||
|
|
.sc-FhnSQ .sc-FhnSQ{font-size:0.929em;}/*!sc*/
|
||
|
|
data-styled.g101[id="sc-FhnSQ"]{content:"bquqCV,jtzvEg,"}/*!sc*/
|
||
|
|
.dsPLkk{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
|
||
|
|
data-styled.g102[id="sc-cwcSVF"]{content:"dsPLkk,"}/*!sc*/
|
||
|
|
.cNpcJW{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
|
||
|
|
.cNpcJW:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
|
||
|
|
.cNpcJW .sc-dibcMh{height:1.5em;width:1.5em;}/*!sc*/
|
||
|
|
.cNpcJW .sc-dibcMh polygon{fill:#333333;}/*!sc*/
|
||
|
|
.bqKYCQ{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;}/*!sc*/
|
||
|
|
.bqKYCQ:hover{color:#32329f;background-color:#ededed;}/*!sc*/
|
||
|
|
.bqKYCQ .sc-dibcMh{height:1.5em;width:1.5em;}/*!sc*/
|
||
|
|
.bqKYCQ .sc-dibcMh polygon{fill:#333333;}/*!sc*/
|
||
|
|
data-styled.g103[id="sc-fuBaRS"]{content:"cNpcJW,bqKYCQ,"}/*!sc*/
|
||
|
|
.dsZUKj{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
|
||
|
|
data-styled.g104[id="sc-hlwFUH"]{content:"dsZUKj,"}/*!sc*/
|
||
|
|
.eVjdzv{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
|
||
|
|
.eVjdzv a,.eVjdzv a:visited,.eVjdzv a:hover{color:#333333!important;padding:5px 0;border-top:1px solid #e1e1e1;text-decoration:none;display:flex;align-items:center;justify-content:center;}/*!sc*/
|
||
|
|
.eVjdzv img{width:15px;margin-right:5px;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.eVjdzv{width:100%;}}/*!sc*/
|
||
|
|
data-styled.g105[id="sc-kXtNZI"]{content:"eVjdzv,"}/*!sc*/
|
||
|
|
.cgvUrj{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
|
||
|
|
data-styled.g111[id="sc-eUzzst"]{content:"cgvUrj,"}/*!sc*/
|
||
|
|
.hgvsuc{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
|
||
|
|
data-styled.g112[id="sc-jgoAos"]{content:"hgvsuc,"}/*!sc*/
|
||
|
|
.ecNgtW{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:flex;white-space:nowrap;align-items:center;border:1px solid transparent;border-bottom:0;transition:border-color 0.25s ease;}/*!sc*/
|
||
|
|
.ecNgtW ..sc-jgoAos{color:#ffffff;}/*!sc*/
|
||
|
|
.ecNgtW:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
|
||
|
|
data-styled.g113[id="sc-bpAAPv"]{content:"ecNgtW,"}/*!sc*/
|
||
|
|
.deMhiD{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
|
|
.bGwxfC{font-size:0.929em;line-height:20px;background-color:#A23DAD;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
|
|
.igIzFW{font-size:0.929em;line-height:20px;background-color:#95507c;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
|
|
.BkeVf{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
|
|
.bxmdGF{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
|
||
|
|
data-styled.g114[id="sc-fBpBLu"]{content:"deMhiD,bGwxfC,igIzFW,BkeVf,bxmdGF,"}/*!sc*/
|
||
|
|
.bVkkkk{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
|
||
|
|
data-styled.g115[id="sc-dXqqap"]{content:"bVkkkk,"}/*!sc*/
|
||
|
|
.jlEXoB{padding:10px;}/*!sc*/
|
||
|
|
data-styled.g116[id="sc-ijfqWo"]{content:"jlEXoB,"}/*!sc*/
|
||
|
|
.zPpwX{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
|
||
|
|
.zPpwX >span{color:#333333;}/*!sc*/
|
||
|
|
data-styled.g117[id="sc-srrxr"]{content:"zPpwX,"}/*!sc*/
|
||
|
|
.dMNSOR{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
|
||
|
|
data-styled.g118[id="sc-eEgstq"]{content:"dMNSOR,"}/*!sc*/
|
||
|
|
.gfsyZD{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
|
||
|
|
.gfsyZD:focus{outline:auto #1d8127;}/*!sc*/
|
||
|
|
.kdKxoT{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);cursor:default;}/*!sc*/
|
||
|
|
.kdKxoT:focus{outline:auto #d41f1c;}/*!sc*/
|
||
|
|
.kdKxoT::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
||
|
|
.kdKxoT:focus{outline:0;}/*!sc*/
|
||
|
|
.henAuh{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/
|
||
|
|
.henAuh:focus{outline:auto #1d8127;}/*!sc*/
|
||
|
|
.henAuh::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
|
||
|
|
.henAuh:focus{outline:0;}/*!sc*/
|
||
|
|
data-styled.g120[id="sc-jthNAk"]{content:"gfsyZD,kdKxoT,henAuh,"}/*!sc*/
|
||
|
|
.ecXPYN{vertical-align:top;}/*!sc*/
|
||
|
|
data-styled.g123[id="sc-eOObWA"]{content:"ecXPYN,"}/*!sc*/
|
||
|
|
.jWGRrJ{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
|
||
|
|
data-styled.g124[id="sc-gSVmdp"]{content:"jWGRrJ,"}/*!sc*/
|
||
|
|
.fARMpn{margin-bottom:30px;}/*!sc*/
|
||
|
|
data-styled.g129[id="sc-bkBUWa"]{content:"fARMpn,"}/*!sc*/
|
||
|
|
.dpoYnd{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:#32329f;}/*!sc*/
|
||
|
|
data-styled.g130[id="sc-doJfcP"]{content:"dpoYnd,"}/*!sc*/
|
||
|
|
.eMcOhX{width:260px;background-color:#fafafa;overflow:hidden;display:flex;flex-direction:column;backface-visibility:hidden;height:100vh;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.eMcOhX{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
|
||
|
|
@media print{.eMcOhX{display:none;}}/*!sc*/
|
||
|
|
data-styled.g131[id="sc-fnaTjL"]{content:"eMcOhX,"}/*!sc*/
|
||
|
|
.Flmyj{outline:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0, 0, 0, 0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
|
||
|
|
@media screen and (max-width: 50rem){.Flmyj{display:flex;}}/*!sc*/
|
||
|
|
.Flmyj svg{color:#0065FB;}/*!sc*/
|
||
|
|
@media print{.Flmyj{display:none;}}/*!sc*/
|
||
|
|
data-styled.g132[id="sc-jyPUfK"]{content:"Flmyj,"}/*!sc*/
|
||
|
|
.ePGUxG{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed!important;tap-highlight-color:rgba(0, 0, 0, 0);text-size-adjust:100%;}/*!sc*/
|
||
|
|
.ePGUxG *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
|
||
|
|
data-styled.g133[id="sc-JNBUd"]{content:"ePGUxG,"}/*!sc*/
|
||
|
|
.bDhhVR{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 50rem){.bDhhVR{width:100%;}}/*!sc*/
|
||
|
|
data-styled.g134[id="sc-eVCCQc"]{content:"bDhhVR,"}/*!sc*/
|
||
|
|
.haiOeP{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
|
||
|
|
@media print,screen and (max-width: 75rem){.haiOeP{display:none;}}/*!sc*/
|
||
|
|
data-styled.g135[id="sc-epRJRH"]{content:"haiOeP,"}/*!sc*/
|
||
|
|
.jbjAuv{padding:5px 0;}/*!sc*/
|
||
|
|
data-styled.g136[id="sc-iBGKNG"]{content:"jbjAuv,"}/*!sc*/
|
||
|
|
.jVkBYH{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
|
||
|
|
data-styled.g137[id="sc-lcacaV"]{content:"jVkBYH,"}/*!sc*/
|
||
|
|
.gXFsok{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
|
||
|
|
.gXFsok path{fill:#333333;}/*!sc*/
|
||
|
|
data-styled.g138[id="sc-dYttxY"]{content:"gXFsok,"}/*!sc*/
|
||
|
|
</style>
|
||
|
|
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="redoc"><link rel="preload" as="image" href="https://www.vultr.com/dist/img/brand/vultr-logo-onwhite.svg"/><div class="sc-JNBUd ePGUxG redoc-wrap"><div class="sc-fnaTjL eMcOhX menu-content" style="top:0px;height:calc(100vh - 0px)"><div style="background-color:#fafafa" class="sc-jfcpKv bJrQmZ"><a href="https://www.vultr.com" class="sc-fdnRgs jMqrgI"><img src="https://www.vultr.com/dist/img/brand/vultr-logo-onwhite.svg" alt="vStash - S3 Compatible API and Management" class="sc-ePKekS jXsdle"/></a></div><div role="search" class="sc-iBGKNG jbjAuv"><svg class="sc-dYttxY gXFsok search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-lcacaV jVkBYH search-input" value=""/></div><div class="sc-epGxBs dkdAtf scrollbar-container undefined"><ul role="menu" class="sc-FhnSQ bquqCV"><li tabindex="0" depth="1" data-item-id="section/Features" role="menuitem" aria-label="Features" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS cNpcJW -depth1"><span width="calc(100% - 38px)" title="Features" class="sc-hlwFUH dsZUKj">Features</span></label></li><li tabindex="0" depth="1" data-item-id="section/Authentication" role="menuitem" aria-label="Authentication" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS cNpcJW -depth1"><span width="calc(100% - 38px)" title="Authentication" class="sc-hlwFUH dsZUKj">Authentication</span></label></li><li tabindex="0" depth="1" data-item-id="tag/S3-Buckets" role="menuitem" aria-label="S3 Buckets" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS cNpcJW -depth1"><span width="calc(100% - 38px)" title="S3 Buckets" class="sc-hlwFUH dsZUKj">S3 Buckets</span><svg class="sc-dibcMh bnalXq" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-FhnSQ jtzvEg"><li tabindex="0" depth="2" data-item-id="tag/S3-Buckets/operation/listBuckets" role="menuitem" aria-label="List buckets" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="get" class="sc-jsGcFV kfVmAL operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">List buckets</span></label></li><li tabindex="0" depth="2" data-item-id="tag/S3-Buckets/operation/headBucket" role="menuitem" aria-label="Check if bucket exists" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="head" class="sc-jsGcFV kfVmAL operation-type head">head</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Check if bucket exists</span></label></li><li tabindex="0" depth="2" data-item-id="tag/S3-Buckets/operation/createBucket" role="menuitem" aria-label="Create bucket" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="put" class="sc-jsGcFV kfVmAL operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Create bucket</span></label></li><li tabindex="0" depth="2" data-item-id="tag/S3-Buckets/operation/deleteBucket" role="menuitem" aria-label="Delete bucket" aria-expanded="false" class="sc-cwcSVF dsPLkk"><label class="sc-fuBaRS bqKYCQ -depth2"><span type="delete" class="sc-jsGcFV kfVmAL operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-hlwFUH dsZUKj">Delete bucket</span></label></li><li tabindex="0" depth="2" data-item-id="tag/S3-Buckets/operation/listObjects" role="menuitem" aria-label="List objects
|
||
|
|
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
||
|
|
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
||
|
|
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
||
|
|
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
|
||
|
|
-174.68583 0.6895,0 26.281,25.03215 56.8701,
|
||
|
|
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
||
|
|
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
||
|
|
-104.0616 -231.873,-231.248 z
|
||
|
|
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
|
||
|
|
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
|
||
|
|
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
|
||
|
|
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
|
||
|
|
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
|
||
|
|
-174.68583 0.6895,0 26.281,25.03215 56.8701,
|
||
|
|
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
|
||
|
|
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
|
||
|
|
-104.0616 -231.873,-231.248 z
|
||
|
|
" fill="currentColor"></path></g></svg></div></div><div class="sc-eVCCQc bDhhVR api-content"><div class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe api-info"><h1 class="sc-hBDmJg sc-jxDJBN dKykVD hLxGCH">vStash S3 Compatible API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:</p><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><div class="sc-exiKtA iZbnSR"><div class="sc-iMAVTd gMAaXs"><span class="sc-jQfdtf ierfVp">vStash Support<!-- -->:<!-- --> <a href="mailto:support@vultr.com">support@vultr.com</a></span> <span class="sc-jQfdtf ierfVp">URL: <a href="https://www.vultr.com">https://www.vultr.com</a></span> <!-- --> </div></div></div><div data-role="redoc-summary" html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><div data-role="redoc-description" html="<p>A high-performance S3-compatible object storage API with management console.</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>A high-performance S3-compatible object storage API with management console.</p>
|
||
|
|
</div></div></div></div><div id="section/Features" data-section-id="section/Features" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-dTdQuR fHsMSp"><a class="sc-kieALA jOWzfS" href="#section/Features" aria-label="section/Features"></a>Features</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<ul>
|
||
|
|
<li>Full S3 API compatibility for basic operations</li>
|
||
|
|
<li>Multipart upload support</li>
|
||
|
|
<li>Presigned URLs</li>
|
||
|
|
<li>Management console API</li>
|
||
|
|
<li>Enterprise storage backend</li>
|
||
|
|
</ul>
|
||
|
|
"><ul>
|
||
|
|
<li>Full S3 API compatibility for basic operations</li>
|
||
|
|
<li>Multipart upload support</li>
|
||
|
|
<li>Presigned URLs</li>
|
||
|
|
<li>Management console API</li>
|
||
|
|
<li>Enterprise storage backend</li>
|
||
|
|
</ul>
|
||
|
|
</div></div></div><div id="section/Authentication" data-section-id="section/Authentication" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-dTdQuR fHsMSp"><a class="sc-kieALA jOWzfS" href="#section/Authentication" aria-label="section/Authentication"></a>Authentication</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>Uses AWS Signature Version 4 for S3 API endpoints and API keys for management endpoints.</p>
|
||
|
|
"><p>Uses AWS Signature Version 4 for S3 API endpoints and API keys for management endpoints.</p>
|
||
|
|
</div></div></div><div id="tag/S3-Buckets" data-section-id="tag/S3-Buckets" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Buckets" aria-label="tag/S3-Buckets"></a>S3 Buckets</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>S3 bucket operations</p>
|
||
|
|
"><p>S3 bucket operations</p>
|
||
|
|
</div></div></div><div id="tag/S3-Buckets/operation/listBuckets" data-section-id="tag/S3-Buckets/operation/listBuckets" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listBuckets" id="operation/listBuckets" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Buckets/operation/listBuckets" aria-label="tag/S3-Buckets/operation/listBuckets"></a>List buckets<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns a list of all buckets owned by the authenticated sender of the request</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns a list of all buckets owned by the authenticated sender of the request</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">401<!-- --> </strong><div html="<p>Unauthorized</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Unauthorized</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/s3/</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/</div></div></div></div></div></div></div></div><div id="tag/S3-Buckets/operation/headBucket" data-section-id="tag/S3-Buckets/operation/headBucket" class="sc-dYOLZc dRVblm"><div data-section-id="operation/headBucket" id="operation/headBucket" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Buckets/operation/headBucket" aria-label="tag/S3-Buckets/operation/headBucket"></a>Check if bucket exists<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Determines if a bucket exists and you have permission to access it</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Determines if a bucket exists and you have permission to access it</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk henAuh" disabled=""><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Bucket exists and you have access</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket exists and you have access</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="head" class="sc-fBpBLu bGwxfC http-verb head">head</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}</div></div></div></div></div></div></div></div><div id="tag/S3-Buckets/operation/createBucket" data-section-id="tag/S3-Buckets/operation/createBucket" class="sc-dYOLZc dRVblm"><div data-section-id="operation/createBucket" id="operation/createBucket" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Buckets/operation/createBucket" aria-label="tag/S3-Buckets/operation/createBucket"></a>Create bucket<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Creates a new S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Creates a new S3 bucket</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Bucket created successfully</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket created successfully</p>
|
||
|
|
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">409<!-- --> </strong><div html="<p>Bucket already exists</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket already exists</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="put" class="sc-fBpBLu igIzFW http-verb put">put</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}</div></div></div></div></div></div></div></div><div id="tag/S3-Buckets/operation/deleteBucket" data-section-id="tag/S3-Buckets/operation/deleteBucket" class="sc-dYOLZc dRVblm"><div data-section-id="operation/deleteBucket" id="operation/deleteBucket" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Buckets/operation/deleteBucket" aria-label="tag/S3-Buckets/operation/deleteBucket"></a>Delete bucket<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Deletes the S3 bucket. The bucket must be empty before it can be deleted</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Deletes the S3 bucket. The bucket must be empty before it can be deleted</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk henAuh" disabled=""><strong class="sc-eOObWA ecXPYN">204<!-- --> </strong><div html="<p>Bucket deleted successfully</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket deleted successfully</p>
|
||
|
|
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">409<!-- --> </strong><div html="<p>Bucket not empty</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket not empty</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="delete" class="sc-fBpBLu BkeVf http-verb delete">delete</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}</div></div></div></div></div></div></div></div><div id="tag/S3-Buckets/operation/listObjects" data-section-id="tag/S3-Buckets/operation/listObjects" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listObjects" id="operation/listObjects" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Buckets/operation/listObjects" aria-label="tag/S3-Buckets/operation/listObjects"></a>List objects in bucket<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns some or all of the objects in a bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns some or all of the objects in a bucket</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-elFkmj eUkINt">query<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="prefix" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">prefix</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">prefix=photos/</span></div><div><div html="<p>Limits the response to keys that begin with the specified prefix</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Limits the response to keys that begin with the specified prefix</p>
|
||
|
|
</div></div></div></td></tr><tr class=""><td kind="field" title="marker" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">marker</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">marker=photos/2023/</span></div><div><div html="<p>Specifies the key to start with when listing objects</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Specifies the key to start with when listing objects</p>
|
||
|
|
</div></div></div></td></tr><tr class=""><td kind="field" title="max-keys" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">max-keys</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 1 .. 1000 ]<!-- --> </span></span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">1000</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">max-keys=100</span></div><div><div html="<p>Maximum number of keys to return</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Maximum number of keys to return</p>
|
||
|
|
</div></div></div></td></tr><tr class=""><td kind="field" title="delimiter" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">delimiter</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 1 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">delimiter=/</span></div><div><div html="<p>Character used to group keys</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Character used to group keys</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="uploads" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">uploads</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Value<!-- -->:</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">""</span> </div> <div><div html="<p>List multipart uploads when present</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>List multipart uploads when present</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}</div></div></div></div></div></div></div></div><div id="tag/S3-Objects" data-section-id="tag/S3-Objects" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Objects" aria-label="tag/S3-Objects"></a>S3 Objects</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>S3 object operations</p>
|
||
|
|
"><p>S3 object operations</p>
|
||
|
|
</div></div></div><div id="tag/S3-Objects/operation/headObject" data-section-id="tag/S3-Objects/operation/headObject" class="sc-dYOLZc dRVblm"><div data-section-id="operation/headObject" id="operation/headObject" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Objects/operation/headObject" aria-label="tag/S3-Objects/operation/headObject"></a>Get object metadata<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Retrieves metadata from an object without returning the object itself</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Retrieves metadata from an object without returning the object itself</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="head" class="sc-fBpBLu bGwxfC http-verb head">head</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}/{key}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}/{key}</div></div></div></div></div></div></div></div><div id="tag/S3-Objects/operation/getObject" data-section-id="tag/S3-Objects/operation/getObject" class="sc-dYOLZc dRVblm"><div data-section-id="operation/getObject" id="operation/getObject" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Objects/operation/getObject" aria-label="tag/S3-Objects/operation/getObject"></a>Get object<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Retrieves objects from Amazon S3</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Retrieves objects from Amazon S3</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-elFkmj eUkINt">query<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="uploadId" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">uploadId</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>List parts when present with upload ID</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>List parts when present with upload ID</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div><div><button class="sc-jthNAk kdKxoT" disabled=""><strong class="sc-eOObWA ecXPYN">404<!-- --> </strong><div html="<p>Object not found</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Object not found</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}/{key}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}/{key}</div></div></div></div></div></div></div></div><div id="tag/S3-Objects/operation/putObject" data-section-id="tag/S3-Objects/operation/putObject" class="sc-dYOLZc dRVblm"><div data-section-id="operation/putObject" id="operation/putObject" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Objects/operation/putObject" aria-label="tag/S3-Objects/operation/putObject"></a>Put object<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Adds an object to a bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Adds an object to a bucket</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-elFkmj eUkINt">query<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="partNumber" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">partNumber</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 1 .. 10000 ]<!-- --> </span></span></div> <div><div html="<p>Part number for multipart upload</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Part number for multipart upload</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="uploadId" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">uploadId</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Upload ID for multipart upload part</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Upload ID for multipart upload part</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/octet-stream</span></h5><div html="<p>Object data</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Object data</p>
|
||
|
|
</div><div><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm"> <!-- --><<!-- -->binary<!-- -->><!-- --> </span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="put" class="sc-fBpBLu igIzFW http-verb put">put</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}/{key}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}/{key}</div></div></div></div></div></div></div></div><div id="tag/S3-Objects/operation/deleteObject" data-section-id="tag/S3-Objects/operation/deleteObject" class="sc-dYOLZc dRVblm"><div data-section-id="operation/deleteObject" id="operation/deleteObject" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Objects/operation/deleteObject" aria-label="tag/S3-Objects/operation/deleteObject"></a>Delete object<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Removes the null version of an object and inserts a delete marker</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Removes the null version of an object and inserts a delete marker</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-elFkmj eUkINt">query<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="uploadId" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">uploadId</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Abort multipart upload when present</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Abort multipart upload when present</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk henAuh" disabled=""><strong class="sc-eOObWA ecXPYN">204<!-- --> </strong><div html="<p>Object deleted successfully</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Object deleted successfully</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="delete" class="sc-fBpBLu BkeVf http-verb delete">delete</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}/{key}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}/{key}</div></div></div></div></div></div></div></div><div id="tag/S3-Multipart" data-section-id="tag/S3-Multipart" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Multipart" aria-label="tag/S3-Multipart"></a>S3 Multipart</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>S3 multipart upload operations</p>
|
||
|
|
"><p>S3 multipart upload operations</p>
|
||
|
|
</div></div></div><div id="tag/S3-Multipart/operation/multipartUpload" data-section-id="tag/S3-Multipart/operation/multipartUpload" class="sc-dYOLZc dRVblm"><div data-section-id="operation/multipartUpload" id="operation/multipartUpload" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/S3-Multipart/operation/multipartUpload" aria-label="tag/S3-Multipart/operation/multipartUpload"></a>Initiate or complete multipart upload<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Initiates a multipart upload or completes a multipart upload by assembling uploaded parts</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Initiates a multipart upload or completes a multipart upload by assembling uploaded parts</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>AWS4-HMAC-SHA256</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-elFkmj eUkINt">query<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="uploads" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">uploads</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Value<!-- -->:</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">""</span> </div> <div><div html="<p>Initiate multipart upload when present</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Initiate multipart upload when present</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="uploadId" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">uploadId</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Complete multipart upload with this upload ID</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Complete multipart upload with this upload ID</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/xml</span></h5><div html="<p>Complete multipart upload request</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Complete multipart upload request</p>
|
||
|
|
</div><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="Part" class="sc-kHNKno sc-frmfij sc-iyUCga cDFxGr kNAbAx fmWEAp"><span class="sc-hLyRwt lhCIDE"></span><button aria-label="expand Part"><span class="property-name">Part</span><svg class="sc-dibcMh eVNtOe" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">objects</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/s3/{bucket}/{key}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/s3/{bucket}/{key}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/s3/{bucket}/{key}</div></div></div></div></div></div></div></div><div id="tag/Management-Stats" data-section-id="tag/Management-Stats" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Stats" aria-label="tag/Management-Stats"></a>Management - Stats</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>System statistics and monitoring</p>
|
||
|
|
"><p>System statistics and monitoring</p>
|
||
|
|
</div></div></div><div id="tag/Management-Stats/operation/getSystemStats" data-section-id="tag/Management-Stats/operation/getSystemStats" class="sc-dYOLZc dRVblm"><div data-section-id="operation/getSystemStats" id="operation/getSystemStats" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Stats/operation/getSystemStats" aria-label="tag/Management-Stats/operation/getSystemStats"></a>Get system statistics<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns overall system statistics including storage usage, object counts, etc.</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns overall system statistics including storage usage, object counts, etc.</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/stats</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/stats</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/stats</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/stats</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«Rjjja»0" aria-selected="true" aria-disabled="false" aria-controls="panel«Rjjja»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«Rjjja»0" aria-labelledby="tab«Rjjja»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"credentials"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"buckets"</span>: <span class="token number">12</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"objects"</span>: <span class="token number">1250</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_storage"</span>: <span class="token number">1073741824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_storage_human"</span>: <span class="token string">"1.0 GB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active_multipart_uploads"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"active_presigned_urls"</span>: <span class="token number">15</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Credentials" data-section-id="tag/Management-Credentials" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Credentials" aria-label="tag/Management-Credentials"></a>Management - Credentials</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>Access key and credential management</p>
|
||
|
|
"><p>Access key and credential management</p>
|
||
|
|
</div></div></div><div id="tag/Management-Credentials/operation/listCredentials" data-section-id="tag/Management-Credentials/operation/listCredentials" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listCredentials" id="operation/listCredentials" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Credentials/operation/listCredentials" aria-label="tag/Management-Credentials/operation/listCredentials"></a>List credentials<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns a list of all access credentials</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns a list of all access credentials</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/credentials</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/credentials</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/credentials</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/credentials</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2e9jq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9jq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9jq»0" aria-labelledby="tab«R2e9jq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"credentials"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"access_key"</span>: <span class="token string">"AKIAIOSFODNN7EXAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"user_name"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"bucket_count"</span>: <span class="token number">3</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Credentials/operation/createCredential" data-section-id="tag/Management-Credentials/operation/createCredential" class="sc-dYOLZc dRVblm"><div data-section-id="operation/createCredential" id="operation/createCredential" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Credentials/operation/createCredential" aria-label="tag/Management-Credentials/operation/createCredential"></a>Create credential<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Creates a new access credential</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Creates a new access credential</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="user_name" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">user_name</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional user name</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional user name</p>
|
||
|
|
</div></div></div></td></tr><tr class=""><td kind="field" title="access_key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">access_key</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional custom access key (auto-generated if not provided)</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional custom access key (auto-generated if not provided)</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="secret_key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">secret_key</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="<p>Optional custom secret key (auto-generated if not provided)</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Optional custom secret key (auto-generated if not provided)</p>
|
||
|
|
</div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">201<!-- --> </strong><div html="<p>Credential created</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Credential created</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/api/credentials</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/credentials</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/credentials</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/credentials</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2aajq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2aajq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2aajq»0" aria-labelledby="tab«R2aajq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_name"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"access_key"</span>: <span class="token string">"AKIAIOSFODNN7EXAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secret_key"</span>: <span class="token string">"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eajq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eajq»0" tabindex="0" data-rttab="true">201</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eajq»0" aria-labelledby="tab«R2eajq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"access_key"</span>: <span class="token string">"AKIAIOSFODNN7EXAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"secret_key"</span>: <span class="token string">"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_name"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></d
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns detailed information about a specific credential</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->>= 1<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">1</span></div><div><div html="<p>Unique identifier for the credential</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Unique identifier for the credential</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/credentials/{id}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/credentials/{id}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/credentials/{id}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/credentials/{id}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebjq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebjq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebjq»0" aria-labelledby="tab«R2ebjq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"access_key"</span>: <span class="token string">"AKIAIOSFODNN7EXAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"user_name"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_active"</span>: <span class="token boolean">true</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"bucket_count"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"buckets"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"my-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"region"</span>: <span class="token string">"us-east-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owner"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object_count"</span>: <span class="token number">150</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_size"</span>: <span class="token number">1073741824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_size_human"</span>: <span class="token string">"1.0
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Updates an existing credential</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->>= 1<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">1</span></div><div><div html="<p>Unique identifier for the credential</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Unique identifier for the credential</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="user_name" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">user_name</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr><tr class="last "><td kind="field" title="is_active" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">is_active</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">boolean</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Credential updated</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Credential updated</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="put" class="sc-fBpBLu igIzFW http-verb put">put</span><span class="sc-jgoAos hgvsuc">/api/credentials/{id}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/credentials/{id}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/credentials/{id}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/credentials/{id}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2acjq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2acjq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2acjq»0" aria-labelledby="tab«R2acjq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user_name"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_active"</span>: <span class="token boolean">true</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ecjq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ecjq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ecjq»0" aria-labelledby="tab«R2ecjq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Operation completed successfully"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Credentials/operation/deleteCredential" data-section-id="tag/Management-Credentials/operation/deleteCredential" class="sc-dYOLZc dRVblm"><div data-section-id="operation/deleteCredential" id="operation/deleteCredential" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Credentials/operation/deleteCredential" aria-label="tag/Management-Credentials/operation/deleteCredential"></a>Delete credential<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Deletes an access credential</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Deletes an access credential</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->>= 1<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">1</span></div><div><div html="<p>Unique identifier for the credential</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Unique identifier for the credential</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Credential deleted</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Credential deleted</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="delete" class="sc-fBpBLu BkeVf http-verb delete">delete</span><span class="sc-jgoAos hgvsuc">/api/credentials/{id}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/credentials/{id}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/credentials/{id}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/credentials/{id}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2edjq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2edjq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2edjq»0" aria-labelledby="tab«R2edjq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Operation completed successfully"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Buckets" data-section-id="tag/Management-Buckets" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Buckets" aria-label="tag/Management-Buckets"></a>Management - Buckets</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>Bucket management via console</p>
|
||
|
|
"><p>Bucket management via console</p>
|
||
|
|
</div></div></div><div id="tag/Management-Buckets/operation/listBucketsManagement" data-section-id="tag/Management-Buckets/operation/listBucketsManagement" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listBucketsManagement" id="operation/listBucketsManagement" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Buckets/operation/listBucketsManagement" aria-label="tag/Management-Buckets/operation/listBucketsManagement"></a>List all buckets<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns a list of all buckets with detailed information</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns a list of all buckets with detailed information</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/buckets</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2e9ka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9ka»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9ka»0" aria-labelledby="tab«R2e9ka»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"buckets"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"my-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"region"</span>: <span class="token string">"us-east-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"owner"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object_count"</span>: <span class="token number">150</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_size"</span>: <span class="token number">1073741824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_size_human"</span>: <span class="token string">"1.0 GB"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Buckets/operation/createBucketManagement" data-section-id="tag/Management-Buckets/operation/createBucketManagement" class="sc-dYOLZc dRVblm"><div data-section-id="operation/createBucketManagement" id="operation/createBucketManagement" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Buckets/operation/createBucketManagement" aria-label="tag/Management-Buckets/operation/createBucketManagement"></a>Create bucket<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Creates a new bucket via management API</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Creates a new bucket via management API</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="name" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">name</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr><tr class=""><td kind="field" title="owner_id" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">owner_id</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr><tr class="last "><td kind="field" title="region" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">region</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"us-east-1"</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">201<!-- --> </strong><div html="<p>Bucket created</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket created</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/api/buckets</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2aaka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2aaka»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2aaka»0" aria-labelledby="tab«R2aaka»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"my-new-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner_id"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"region"</span>: <span class="token string">"us-east-1"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eaka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eaka»0" tabindex="0" data-rttab="true">201</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eaka»0" aria-labelledby="tab«R2eaka»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"my-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"region"</span>: <span class="token string">"us-east-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object_count"</span>: <span class="token number">150</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_size"</span>: <span class="token number">1073741824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns detailed information about a specific bucket including objects</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebka»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebka»0" aria-labelledby="tab«R2ebka»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"name"</span>: <span class="token string">"my-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"region"</span>: <span class="token string">"us-east-1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"owner"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object_count"</span>: <span class="token number">150</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_size"</span>: <span class="token number">1073741824</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"total_size_human"</span>: <span class="token string">"1.0 GB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"objects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"photos/vacation.jpg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">1024000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size_human"</span>: <span class="token string">"1.0 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content_type"</span>: <span class="token string">"image/jpeg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"etag"</span>: <span class="token string">"9bb58f26192e4ba00f01e2e7b136bbd8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_multipart"</span>:
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Deletes a bucket via management API</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Bucket deleted</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Bucket deleted</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="delete" class="sc-fBpBLu BkeVf http-verb delete">delete</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ecka»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ecka»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ecka»0" aria-labelledby="tab«R2ecka»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Operation completed successfully"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Objects" data-section-id="tag/Management-Objects" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Objects" aria-label="tag/Management-Objects"></a>Management - Objects</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>Object management via console</p>
|
||
|
|
"><p>Object management via console</p>
|
||
|
|
</div></div></div><div id="tag/Management-Objects/operation/listObjectsManagement" data-section-id="tag/Management-Objects/operation/listObjectsManagement" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listObjectsManagement" id="operation/listObjectsManagement" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Objects/operation/listObjectsManagement" aria-label="tag/Management-Objects/operation/listObjectsManagement"></a>List objects in bucket<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns a list of objects in the specified bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns a list of objects in the specified bucket</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-elFkmj eUkINt">query<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="prefix" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">prefix</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">prefix=photos/</span></div><div><div html="<p>Limits the response to keys that begin with the specified prefix</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Limits the response to keys that begin with the specified prefix</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}/objects</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}/objects</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}/objects</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}/objects</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2e9kq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2e9kq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2e9kq»0" aria-labelledby="tab«R2e9kq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"objects"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"key"</span>: <span class="token string">"photos/vacation.jpg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size"</span>: <span class="token number">1024000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"size_human"</span>: <span class="token string">"1.0 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content_type"</span>: <span class="token string">"image/jpeg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"etag"</span>: <span class="token string">"9bb58f26192e4ba00f01e2e7b136bbd8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"is_multipart"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Objects/operation/deleteMultipleObjects" data-section-id="tag/Management-Objects/operation/deleteMultipleObjects" class="sc-dYOLZc dRVblm"><div data-section-id="operation/deleteMultipleObjects" id="operation/deleteMultipleObjects" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Objects/operation/deleteMultipleObjects" aria-label="tag/Management-Objects/operation/deleteMultipleObjects"></a>Delete multiple objects<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Deletes multiple objects from a bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Deletes multiple objects from a bucket</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="keys" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">keys</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu">Array of </span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">strings</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Objects deleted</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Objects deleted</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="delete" class="sc-fBpBLu BkeVf http-verb delete">delete</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}/objects</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}/objects</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}/objects</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}/objects</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R2aakq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2aakq»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2aakq»0" aria-labelledby="tab«R2aakq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"keys"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file1.txt"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"file2.txt"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"folder/file3.txt"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eakq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eakq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eakq»0" aria-labelledby="tab«R2eakq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"deleted"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"file1.txt"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"file2.txt"</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Objects/operation/getObjectDetails" data-section-id="tag/Management-Objects/operation/getObjectDetails" class="sc-dYOLZc dRVblm"><div data-section-id="operation/getObjectDetails" id="operation/getObjectDetails" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Objects/ope
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns detailed information about a specific object</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}/objects/{objectKey}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}/objects/{objectKey}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}/objects/{objectKey}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}/objects/{objectKey}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2ebkq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2ebkq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2ebkq»0" aria-labelledby="tab«R2ebkq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"key"</span>: <span class="token string">"photos/vacation.jpg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size"</span>: <span class="token number">1024000</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"size_human"</span>: <span class="token string">"1.0 MB"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"content_type"</span>: <span class="token string">"image/jpeg"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"etag"</span>: <span class="token string">"9bb58f26192e4ba00f01e2e7b136bbd8"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"is_multipart"</span>: <span class="token boolean">false</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"part_count"</span>: <span class="token number">0</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"metadata"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"user-id"</span>: <span class="token string">"12345"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"category"</span>: <span class="token string">"photos"</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"storage_path"</span>: <span class="token string">"my-bucket/objects/ab/cd/abcdef123456..."</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"updated_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Objects/operation/deleteObjectManagement" data-section-id="tag/Management-Objects/operation/delet
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Deletes a specific object</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- --><= 255 characters<!-- --> </span></span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">folder/file.txt</span></div><div><div html="<p>Object key (file path) within the bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Object key (file path) within the bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Object deleted</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Object deleted</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="delete" class="sc-fBpBLu BkeVf http-verb delete">delete</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}/objects/{objectKey}</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}/objects/{objectKey}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}/objects/{objectKey}</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}/objects/{objectKey}</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2eckq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2eckq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2eckq»0" aria-labelledby="tab«R2eckq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"Operation completed successfully"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Objects/operation/listMultipartUploads" data-section-id="tag/Management-Objects/operation/listMultipartUploads" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listMultipartUploads" id="operation/listMultipartUploads" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Objects/operation/listMultipartUploads" aria-label="tag/Management-Objects/operation/listMultipartUploads"></a>List multipart uploads<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns active multipart uploads for a bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns active multipart uploads for a bucket</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h5 class="sc-elFkmj eUkINt">path<!-- --> Parameters</h5><table class="sc-eGjrzz cGiuNU"><tbody><tr class="last "><td kind="field" title="bucket" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 3 .. 63 ] characters<!-- --> </span></span><span class="sc-byRegH sc-cExZcH eyIabj kRjrIj">^[a-z0-9\-\.]+$</span></div> <div><span class="sc-byRegH eyIabj"> <!-- -->Example:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">my-bucket</span></div><div><div html="<p>Name of the S3 bucket</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Name of the S3 bucket</p>
|
||
|
|
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/buckets/{bucketName}/multipart-uploads</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/buckets/{bucketName}/multipart-uploads</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/buckets/{bucketName}/multipart-uploads</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/buckets/{bucketName}/multipart-uploads</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R2edkq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R2edkq»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R2edkq»0" aria-labelledby="tab«R2edkq»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"uploads"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"upload_id"</span>: <span class="token string">"upload_12345_abcdef"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object_key"</span>: <span class="token string">"large-file.zip"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"initiated_by"</span>: <span class="token string">"john-doe"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"content_type"</span>: <span class="token string">"application/zip"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"initiated_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"part_count"</span>: <span class="token number">5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_size"</span>: <span class="token number">26214400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"total_size_human"</span>: <span class="token string">"25.0 MB"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Presigned-URLs" data-section-id="tag/Management-Presigned-URLs" class="sc-dYOLZc kDuBQd"><div class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Presigned-URLs" aria-label="tag/Management-Presigned-URLs"></a>Management - Presigned URLs</h2></div></div><div class="sc-gwsNht ciCSbi"><div class="sc-faJlkc sc-fdduAw kOqeZB kEOvim redoc-markdown " html="<p>Presigned URL management</p>
|
||
|
|
"><p>Presigned URL management</p>
|
||
|
|
</div></div></div><div id="tag/Management-Presigned-URLs/operation/listPresignedUrls" data-section-id="tag/Management-Presigned-URLs/operation/listPresignedUrls" class="sc-dYOLZc dRVblm"><div data-section-id="operation/listPresignedUrls" id="operation/listPresignedUrls" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Presigned-URLs/operation/listPresignedUrls" aria-label="tag/Management-Presigned-URLs/operation/listPresignedUrls"></a>List presigned URLs<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Returns active presigned URLs</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Returns active presigned URLs</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">200<!-- --> </strong><div html="<p>Success</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Success</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="get" class="sc-fBpBLu deMhiD http-verb get">get</span><span class="sc-jgoAos hgvsuc">/api/presigned-urls</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/presigned-urls</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/presigned-urls</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/presigned-urls</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R175la»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R175la»0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R175la»0" aria-labelledby="tab«R175la»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"urls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"bucket_name"</span>: <span class="token string">"my-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"object_key"</span>: <span class="token string">"file.txt"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"access_key"</span>: <span class="token string">"AKIAIOSFODNN7EXAMPLE"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"expires_at"</span>: <span class="token string">"2023-01-15T11:30:00Z"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">"2023-01-15T10:30:00Z"</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Management-Presigned-URLs/operation/createPresignedUrl" data-section-id="tag/Management-Presigned-URLs/operation/createPresignedUrl" class="sc-dYOLZc dRVblm"><div data-section-id="operation/createPresignedUrl" id="operation/createPresignedUrl" class="sc-jZhnRx tMeMv"><div class="sc-gwsNht iRoSfe"><h2 class="sc-kThouk jkwlQD"><a class="sc-kieALA jOWzfS" href="#tag/Management-Presigned-URLs/operation/createPresignedUrl" aria-label="tag/Management-Presigned-URLs/operation/createPresignedUrl"></a>Create presigned URL<!-- --> </h2><div class="sc-bkBUWa fARMpn"><div html="<p>Generates a new presigned URL</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"><p>Generates a new presigned URL</p>
|
||
|
|
</div></div><div class="sc-hUPhBQ iaIgja"><div class="sc-ilCyfT gqqgtC"><h5 class="sc-elFkmj sc-gUMLBR eUkINt jefPco">Authorizations:</h5><svg class="sc-dibcMh gsIrbT" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-jlEUfS dNXpfB"><span class="sc-iFRVkA WPZDV"><span class="sc-hFPzkB eSQudw"><i>ApiKey</i></span></span></div></div><h5 class="sc-elFkmj eUkINt">Request Body schema: <span class="sc-edaYAx iFdOsg">application/json</span><div class="sc-byRegH sc-isZTFa sc-eEgstq eyIabj iUhYwd dMNSOR">required</div></h5><div html="" class="sc-faJlkc sc-fdduAw kOqeZB kEOvim"></div><table class="sc-eGjrzz cGiuNU"><tbody><tr class=""><td kind="field" title="bucket_name" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">bucket_name</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr><tr class=""><td kind="field" title="object_key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">object_key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr><tr class=""><td kind="field" title="method" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">method</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"GET"</span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Enum<!-- -->:</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"GET"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"PUT"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"POST"</span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">"DELETE"</span> </div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr><tr class=""><td kind="field" title="expires_in" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">expires_in</span></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">integer</span><span> <span class="sc-byRegH sc-fYNhqQ eyIabj gqMqVY"> <!-- -->[ 1 .. 604800 ]<!-- --> </span></span></div><div><span class="sc-byRegH eyIabj"> <!-- -->Default:<!-- --> </span> <span class="sc-byRegH sc-dEAvcG eyIabj ewbVMc">3600</span></div> <div><div html="<p>Expiration time in seconds (max 7 days)</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Expiration time in seconds (max 7 days)</p>
|
||
|
|
</div></div></div></td></tr><tr class="last "><td kind="field" title="access_key" class="sc-kHNKno sc-frmfij cDFxGr kNAbAx"><span class="sc-hLyRwt lhCIDE"></span><span class="property-name">access_key</span><div class="sc-byRegH sc-isZTFa eyIabj iUhYwd">required</div></td><td class="sc-groBii dzPbxx"><div><div><span class="sc-byRegH sc-budtlk eyIabj jGdyyu"></span><span class="sc-byRegH sc-fJvEKN eyIabj fcQkkm">string</span></div> <div><div html="" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"></div></div></div></td></tr></tbody></table><div><h3 class="sc-gSVmdp jWGRrJ">Responses</h3><div><button class="sc-jthNAk gfsyZD"><svg class="sc-dibcMh dpIKEE" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-eOObWA ecXPYN">201<!-- --> </strong><div html="<p>Presigned URL created</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw sc-eINXvP kOqeZB kkltVg fbuMAW"><p>Presigned URL created</p>
|
||
|
|
</div></button></div></div></div><div class="sc-jMpmlX sc-hoLldG kCcXaS jpPJrn"><div class="sc-eUzzst cgvUrj"><button class="sc-bpAAPv ecNgtW"><span type="post" class="sc-fBpBLu bxmdGF http-verb post">post</span><span class="sc-jgoAos hgvsuc">/api/presigned-urls</span><svg class="sc-dibcMh NOyYc" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dXqqap bVkkkk"><div class="sc-ijfqWo jlEXoB"><div html="<p>Production server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Production server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash.vultr.com</span>/api/presigned-urls</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Staging server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Staging server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>https://vstash-staging.vultr.com</span>/api/presigned-urls</div></div></div><div class="sc-ijfqWo jlEXoB"><div html="<p>Development server</p>
|
||
|
|
" class="sc-faJlkc sc-fdduAw kOqeZB csbUjU"><p>Development server</p>
|
||
|
|
</div><div tabindex="0" role="button"><div class="sc-srrxr zPpwX"><span>http://localhost:8000</span>/api/presigned-urls</div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Request samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab«R156la»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R156la»0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R156la»0" aria-labelledby="tab«R156la»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"bucket_name"</span>: <span class="token string">"my-bucket"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"object_key"</span>: <span class="token string">"file.txt"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"method"</span>: <span class="token string">"GET"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"expires_in"</span>: <span class="token number">3600</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"access_key"</span>: <span class="token string">"AKIAIOSFODNN7EXAMPLE"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-llIIlC fdkIVZ"> <!-- -->Response samples<!-- --> </h3><div class="sc-cTIdZS dFpYBv" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R176la»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R176la»0" tabindex="0" data-rttab="true">201</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R176la»0" aria-labelledby="tab«R176la»0"><div><div class="sc-bXYrjy fpFYoG"><span class="sc-fUPiRJ TqlOY">Content type</span><div class="sc-bFwXsg caaBgn">application/json</div></div><div class="sc-bgpKpp kuvBhH"><div class="sc-dRHutB iAOzgg"><div class="sc-VILhF itwxyW"><button><div class="sc-fIQtvO indwFD">Copy</div></button></div><div tabindex="0" class="sc-faJlkc kOqeZB sc-eRJQtA eudsMA"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"url"</span>: <span class="token string">"/my-bucket/file.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20230115%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230115T103000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=abc123&hash=def456"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-epRJRH haiOeP"></div></div></div>
|
||
|
|
<script>
|
||
|
|
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"1.0.0","title":"vStash S3 Compatible API","description":"A high-performance S3-compatible object storage API with management console.\n\n## Features\n- Full S3 API compatibility for basic operations\n- Multipart upload support\n- Presigned URLs\n- Management console API\n- Enterprise storage backend\n\n## Authentication\nUses AWS Signature Version 4 for S3 API endpoints and API keys for management endpoints.\n","contact":{"email":"support@vultr.com","name":"vStash Support","url":"https://www.vultr.com"},"x-logo":{"url":"https://www.vultr.com/dist/img/brand/vultr-logo-onwhite.svg","backgroundColor":"#fafafa","altText":"vStash - S3 Compatible API and Management"}},"servers":[{"url":"https://vstash.vultr.com","description":"Production server"},{"url":"https://vstash-staging.vultr.com","description":"Staging server"},{"url":"http://localhost:8000","description":"Development server"}],"tags":[{"name":"S3 Buckets","description":"S3 bucket operations"},{"name":"S3 Objects","description":"S3 object operations"},{"name":"S3 Multipart","description":"S3 multipart upload operations"},{"name":"Management - Stats","description":"System statistics and monitoring"},{"name":"Management - Credentials","description":"Access key and credential management"},{"name":"Management - Buckets","description":"Bucket management via console"},{"name":"Management - Objects","description":"Object management via console"},{"name":"Management - Presigned URLs","description":"Presigned URL management"}],"paths":{"/s3/":{"get":{"operationId":"listBuckets","tags":["S3 Buckets"],"summary":"List buckets","description":"Returns a list of all buckets owned by the authenticated sender of the request","security":[{"AWS4-HMAC-SHA256":[]}],"responses":{"200":{"description":"Success","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CreatePresignedUrlResponse"}}}},"401":{"description":"Unauthorized"}}}},"/s3/{bucket}":{"parameters":[{"$ref":"#/components/parameters/BucketName"}],"head":{"operationId":"headBucket","tags":["S3 Buckets"],"summary":"Check if bucket exists","description":"Determines if a bucket exists and you have permission to access it","security":[{"AWS4-HMAC-SHA256":[]}],"responses":{"200":{"description":"Bucket exists and you have access"}}},"put":{"operationId":"createBucket","tags":["S3 Buckets"],"summary":"Create bucket","description":"Creates a new S3 bucket","security":[{"AWS4-HMAC-SHA256":[]}],"responses":{"200":{"description":"Bucket created successfully","headers":{"Location":{"description":"Location of the created bucket","schema":{"type":"string"}}}},"409":{"description":"Bucket already exists"}}},"delete":{"operationId":"deleteBucket","tags":["S3 Buckets"],"summary":"Delete bucket","description":"Deletes the S3 bucket. The bucket must be empty before it can be deleted","security":[{"AWS4-HMAC-SHA256":[]}],"responses":{"204":{"description":"Bucket deleted successfully"},"409":{"description":"Bucket not empty"}}},"get":{"operationId":"listObjects","tags":["S3 Buckets"],"summary":"List objects in bucket","description":"Returns some or all of the objects in a bucket","security":[{"AWS4-HMAC-SHA256":[]}],"parameters":[{"$ref":"#/components/parameters/Prefix"},{"$ref":"#/components/parameters/Marker"},{"$ref":"#/components/parameters/MaxKeys"},{"$ref":"#/components/parameters/Delimiter"},{"name":"uploads","in":"query","description":"List multipart uploads when present","schema":{"type":"string","enum":[""]}}],"responses":{"200":{"description":"Success","content":{"application/xml":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ListBucketResult"},{"$ref":"#/components/schemas/ListMultipartUploadsResult"}]}}}}}}},"/s3/{bucket}/{key}":{"parameters":[{"$ref":"#/components/parameters/BucketName"},{"$ref":"#/components/parameters/ObjectKey"}],"head":{"operationId":"headObject","tags":["S3 Objects"],"summary":"Get object metadata","description":"Retrieves metadata from an object without returning the object itself","sec
|
||
|
|
|
||
|
|
var container = document.getElementById('redoc');
|
||
|
|
Redoc.hydrate(__redoc_state, container);
|
||
|
|
|
||
|
|
</script>
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|