atlas-app-services-admin-api

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServicesApiInterface | atlas-app-services-admin-api</title><meta name="description" content="Documentation for atlas-app-services-admin-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base=".."> <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <div class="field"> <div id="tsd-toolbar-links"></div></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">atlas-app-services-admin-api</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header> <div class="container container-main"> <div class="col-content"> <div class="tsd-page-title"> <ul class="tsd-breadcrumb"> <li><a href="../index.html">atlas-app-services-admin-api</a></li> <li><a href="../modules/api.html">api</a></li> <li><a href="api.ServicesApiInterface.html">ServicesApiInterface</a></li></ul> <h1>Interface ServicesApiInterface</h1></div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"><p>ServicesApi - interface</p> </div> <div class="tsd-comment tsd-typography"> <h4>Export</h4><p>ServicesApi</p> </div></section> <section class="tsd-panel tsd-hierarchy"> <h4>Hierarchy</h4> <ul class="tsd-hierarchy"> <li><span class="target">ServicesApiInterface</span></li></ul></section> <section class="tsd-panel"> <h4>Implemented by</h4> <ul class="tsd-hierarchy"> <li><a href="../classes/api.ServicesApi.html" class="tsd-signature-type tsd-kind-class">ServicesApi</a></li></ul></section><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19153">src/api.ts:19153</a></li></ul></aside> <section class="tsd-panel-group tsd-index-group"> <section class="tsd-panel tsd-index-panel"> <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary> <div class="tsd-accordion-details"> <section class="tsd-index-section"> <h3 class="tsd-index-heading">Methods</h3> <div class="tsd-index-list"><a href="api.ServicesApiInterface.html#adminCreateService" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Create<wbr/>Service</span></a> <a href="api.ServicesApiInterface.html#adminDeleteService" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Delete<wbr/>Service</span></a> <a href="api.ServicesApiInterface.html#adminGenerateSchema" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Generate<wbr/>Schema</span></a> <a href="api.ServicesApiInterface.html#adminGetService" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Service</span></a> <a href="api.ServicesApiInterface.html#adminGetServiceConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Service<wbr/>Config</span></a> <a href="api.ServicesApiInterface.html#adminListServices" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>List<wbr/>Services</span></a> <a href="api.ServicesApiInterface.html#adminRunCommand" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Run<wbr/>Command</span></a> <a href="api.ServicesApiInterface.html#adminUpdateService" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>Service</span></a> <a href="api.ServicesApiInterface.html#adminUpdateServiceConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>Service<wbr/>Config</span></a> <a href="api.ServicesApiInterface.html#getBuildInfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Build<wbr/>Info</span></a> </div></section></div></details></section></section> <section class="tsd-panel-group tsd-member-group"> <h2>Methods</h2> <section class="tsd-panel tsd-member"><a id="adminCreateService" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Create<wbr/>Service</span><a href="#adminCreateService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminCreateService.adminCreateService-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#adminCreateService.adminCreateService-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Create a <a href="https://www.mongodb.com/docs/atlas/app-services/mongodb/">data source</a> or <a href="https://www.mongodb.com/docs/atlas/app-services/reference/services/">third-party service [Deprecated]</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Create a data source or third-party service</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19164">src/api.ts:19164</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminDeleteService" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Delete<wbr/>Service</span><a href="#adminDeleteService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminDeleteService.adminDeleteService-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#adminDeleteService.adminDeleteService-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Delete a <a href="https://www.mongodb.com/docs/atlas/app-services/mongodb/">data source</a> or <a href="https://www.mongodb.com/docs/atlas/app-services/reference/services/">third-party service [Deprecated]</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Delete a data source or third-party service</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19176">src/api.ts:19176</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGenerateSchema" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Generate<wbr/>Schema</span><a href="#adminGenerateSchema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGenerateSchema.adminGenerateSchema-1"><span class="tsd-kind-call-signature">admin<wbr/>Generate<wbr/>Schema</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">adminGenerateSchemaRequest</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="api.AdminGenerateSchema200Response.html" class="tsd-signature-type tsd-kind-interface">AdminGenerateSchema200Response</a><span class="tsd-signature-symbol">></span><a href="#adminGenerateSchema.adminGenerateSchema-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Sample a subset of documents in a collection to generate a JSON schema.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">adminGenerateSchemaRequest</span>: <a href="api.AdminGenerateSchemaRequest.html" class="tsd-signature-type tsd-kind-interface">AdminGenerateSchemaRequest</a></h5> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="api.AdminGenerateSchema200Response.html" class="tsd-signature-type tsd-kind-interface">AdminGenerateSchema200Response</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Generate a JSON schema from sample</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19189">src/api.ts:19189</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGetService" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>Service</span><a href="#adminGetService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGetService.adminGetService-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#adminGetService.adminGetService-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Get a <a href="https://www.mongodb.com/docs/atlas/app-services/mongodb/">data source</a> or <a href="https://www.mongodb.com/docs/atlas/app-services/reference/services/">third-party service [Deprecated]</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get a data source or third-party service</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19201">src/api.ts:19201</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminGetServiceConfig" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>Service<wbr/>Config</span><a href="#adminGetServiceConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminGetServiceConfig.adminGetServiceConfig-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Service<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#adminGetServiceConfig.adminGetServiceConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Retrieve a <a href="https://www.mongodb.com/docs/realm/services#std-label-services">service's</a> configuration.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Retrieve a service's configuration</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19213">src/api.ts:19213</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminListServices" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>List<wbr/>Services</span><a href="#adminListServices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminListServices.adminListServices-1"><span class="tsd-kind-call-signature">admin<wbr/>List<wbr/>Services</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#adminListServices.adminListServices-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>List all <a href="https://www.mongodb.com/docs/atlas/app-services/mongodb/">data sources</a> and <a href="https://www.mongodb.com/docs/atlas/app-services/reference/services/">third-party services [Deprecated]</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>List all data sources and third-party services</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19224">src/api.ts:19224</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminRunCommand" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Run<wbr/>Command</span><a href="#adminRunCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminRunCommand.adminRunCommand-1"><span class="tsd-kind-call-signature">admin<wbr/>Run<wbr/>Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">commandName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#adminRunCommand.adminRunCommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Run a command associated with a <a href="https://www.mongodb.com/docs/realm/services#std-label-services">service</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">commandName</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Command name</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Run a command associated with a service</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19237">src/api.ts:19237</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminUpdateService" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Update<wbr/>Service</span><a href="#adminUpdateService" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminUpdateService.adminUpdateService-1"><span class="tsd-kind-call-signature">admin<wbr/>Update<wbr/>Service</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#adminUpdateService.adminUpdateService-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Update a <a href="https://www.mongodb.com/docs/realm/services#std-label-services">service</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Update a service</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19249">src/api.ts:19249</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="adminUpdateServiceConfig" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>admin<wbr/>Update<wbr/>Service<wbr/>Config</span><a href="#adminUpdateServiceConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="adminUpdateServiceConfig.adminUpdateServiceConfig-1"><span class="tsd-kind-call-signature">admin<wbr/>Update<wbr/>Service<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#adminUpdateServiceConfig.adminUpdateServiceConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Update a <a href="https://www.mongodb.com/docs/realm/services#std-label-services">service's</a> configuration.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Update a service's configuration</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19261">src/api.ts:19261</a></li></ul></aside></li></ul></section> <section class="tsd-panel tsd-member"><a id="getBuildInfo" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>get<wbr/>Build<wbr/>Info</span><a href="#getBuildInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="getBuildInfo.getBuildInfo-1"><span class="tsd-kind-call-signature">get<wbr/>Build<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="api.BuildInfo.html" class="tsd-signature-type tsd-kind-interface">BuildInfo</a><span class="tsd-signature-symbol">></span><a href="#getBuildInfo.getBuildInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="api.BuildInfo.html" class="tsd-signature-type tsd-kind-interface">BuildInfo</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get information about the underlying Atlas mongod</p> <h4>Throws</h4> <h4>Memberof</h4><p>ServicesApiInterface</p> </div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L19273">src/api.ts:19273</a></li></ul></aside></li></ul></section></section></div> <div class="col-sidebar"> <div class="page-menu"> <div class="tsd-navigation settings"> <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary> <div class="tsd-accordion-details"> <div class="tsd-filter-visibility"> <h4 class="uppercase">Member Visibility</h4><form> <ul id="tsd-filter-options"> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> <div class="tsd-theme-toggle"> <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary> <div class="tsd-accordion-details"> <ul> <li><a href="#adminCreateService" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Create<wbr/>Service</span></a></li> <li><a href="#adminDeleteService" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Delete<wbr/>Service</span></a></li> <li><a href="#adminGenerateSchema" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Generate<wbr/>Schema</span></a></li> <li><a href="#adminGetService" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Service</span></a></li> <li><a href="#adminGetServiceConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Service<wbr/>Config</span></a></li> <li><a href="#adminListServices" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>List<wbr/>Services</span></a></li> <li><a href="#adminRunCommand" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Run<wbr/>Command</span></a></li> <li><a href="#adminUpdateService" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>Service</span></a></li> <li><a href="#adminUpdateServiceConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>Service<wbr/>Config</span></a></li> <li><a href="#getBuildInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Build<wbr/>Info</span></a></li></ul></div></details></div> <div class="site-menu"> <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>atlas-app-services-admin-api</span></a> <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."> <li><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>api</a></li> <li><a href="../modules/base.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>base</a></li> <li><a href="../modules/client.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>client</a></li> <li><a href="../modules/client_spec.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>client.spec</a></li> <li><a href="../modules/common.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>common</a></li> <li><a href="../modules/configuration.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>configuration</a></li> <li><a href="../modules/index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2"></use></svg>index</a></li></ul></nav></div></div></div> <div class="tsd-generator"> <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div> <div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></pa