Ask the Community
Groups
BMS Rest APIs V2 - Connect IT Community | Kaseya
<main> <article class="userContent"> <p>Introduction </p> <p><span data-contrast="auto">BMS has a REST API which is documented using Swagger. On SwaggerUI, you can view all the endpoints and try them.</span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":259}"> </span></p> <p><strong><span data-contrast="auto">Note</span></strong><span data-contrast="auto">: The original V1 API documented at <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fbms.kaseya.com%2Fapi" rel="noopener nofollow">https://bms.kaseya.com/api</a> is still available but will no longer receive any enhancements.</span><span data-ccp-props="{"201341983":0,"335559739":160,"335559740":259}"></span></p> <p>Resources</p> <p aria-level="1"><span data-ccp-props="{"201341983":0,"335559738":240,"335559739":0,"335559740":259}">Each server has a dedicated swagger interface below are the URLs. </span></p> <ul><li data-leveltext="" data-font="Symbol" data-listid="1" aria-setsize="-1" data-aria-posinset="2" data-aria-level="1"> <a rel="nofollow" href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fapi.bms.kaseya.com%2Fswagger%2Findex.html"><span data-contrast="none"><a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fapi.bms.kaseya.com%2Fswagger">https://api.bms.kaseya.com/swagger</a></span></a><span data-ccp-props="{"134233279":true,"201341983":0,"335559739":160,"335559740":259}"> </span> </li> <li> <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fapi.bmsemea.kaseya.com%2Fswagger%2Findex.html" rel="undefined nofollow">https://api.bmsemea.kaseya.com/swagger</a><span data-ccp-props="{"134233279":true,"201341983":0,"335559739":160,"335559740":259}"> </span> </li> <li> <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fapi.bmsapac.kaseya.com%2Fswagger%2Findex.html" rel="undefined nofollow">https://api.bmsapac.kaseya.com/swagger</a><span data-ccp-props="{"134233279":true,"201341983":0,"335559739":160,"335559740":259}"> </span> </li> <li><a rel="nofollow" href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fapi.vorexlogin.com%2Fswagger"><span data-contrast="none"><a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fapi.vorexlogin.kaseya.com%2Fswagger">https://api.vorexlogin.kaseya.com/swagger</a></span><span data-ccp-props="{"134233279":true,"201341983":0,"335559739":160,"335559740":259}"> </span></a></li> </ul><p>Authentication </p> <ul><li data-leveltext="" data-font="Symbol" data-listid="2" aria-setsize="-1" data-aria-posinset="1" data-aria-level="1"><span data-contrast="auto">With SwaggerUI users can authenticate on our API webpage or use any API collaborative platforms like Postman. </span></li> <li data-leveltext="" data-font="Symbol" data-listid="2" aria-setsize="-1" data-aria-posinset="1" data-aria-level="1"> <span data-contrast="auto">For valid authentication, a user needs to key in </span> <ul><li data-leveltext="" data-font="Symbol" data-listid="2" aria-setsize="-1" data-aria-posinset="1" data-aria-level="1"><span data-contrast="auto"> BMS username and password. </span></li> <li data-leveltext="" data-font="Symbol" data-listid="2" aria-setsize="-1" data-aria-posinset="1" data-aria-level="1"> <span data-contrast="auto">Company name and server URL </span> <ul><li>Navigate to <em>My Profile</em>: Click on your name on the right of the top navigation bar<br>Gateway URL is the server URL of your tenant, eg: <a href="/home/leaving?allowTrusted=1&target=https%3A%2F%2Fbmsemea.kaseya.com%2F">https://bmsemea.kaseya.com/</a>, and Company/Tenant name will be listed here.</li> </ul></li> </ul></li> </ul><h3 data-id="authorize-your-requests">Authorize your requests</h3> <p>To get started, you will have to authorize your session by clicking the Authorize button and fill the user details in the Authorization modal pictured below:</p> <ol><li>Navigate to <strong>/v2/security/authenticate</strong> </li> <li>Expand, click on <strong>Try it out</strong> </li> <li>Fill the form</li> <li>Fill in the following details, execute.</li> </ol><p><img src="https://us.v-cdn.net/6032361/uploads/migrated/WV7UIOO8ADDY/blobid0.png" alt="blobid0.png" class="embedImage-img importedEmbed-img"></img></p> <ul><li>You will receive a token that can be authorized to make other requests. </li> <li>The authorize button on the top of the page will use the API key and validate all of the endpoints</li> </ul><p><img src="https://us.v-cdn.net/6032361/uploads/migrated/BP1FAN2VZCQQ/mceclip0.png" alt="mceclip0.png" class="embedImage-img importedEmbed-img"></img></p> <ul><li>Use refresh token and get a new token without having to refill the form.</li> </ul><p><img src="https://us.v-cdn.net/6032361/uploads/migrated/DTI1QWOHODBL/blobid1.png" alt="blobid1.png" class="embedImage-img importedEmbed-img"></img></p> <p> </p> </article> </main>