mongodb-atlas-api-client
npm
Atlas Admin API v2
Preparing search index...
AtlasSearch
Interface AtlasSearch
interface
AtlasSearch
{
create
(
clusterName
:
string
,
body
:
object
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
;
delete
(
clusterName
:
string
,
indexId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
;
get
(
clusterName
:
string
,
indexId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
;
getAll
(
clusterName
:
string
,
databaseName
:
string
,
collectionName
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
;
update
(
clusterName
:
string
,
indexId
:
string
,
body
:
object
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
;
}
Index
Methods
create
delete
get
get
All
update
Methods
create
create
(
clusterName
:
string
,
body
:
object
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
Parameters
clusterName
:
string
body
:
object
Optional
options
:
AtlasClientOptions
Returns
Promise
<
any
>
delete
delete
(
clusterName
:
string
,
indexId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
Parameters
clusterName
:
string
indexId
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
any
>
get
get
(
clusterName
:
string
,
indexId
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
Parameters
clusterName
:
string
indexId
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
any
>
get
All
getAll
(
clusterName
:
string
,
databaseName
:
string
,
collectionName
:
string
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
Parameters
clusterName
:
string
databaseName
:
string
collectionName
:
string
Optional
options
:
AtlasClientOptions
Returns
Promise
<
any
>
update
update
(
clusterName
:
string
,
indexId
:
string
,
body
:
object
,
options
?:
AtlasClientOptions
,
)
:
Promise
<
any
>
Parameters
clusterName
:
string
indexId
:
string
body
:
object
Optional
options
:
AtlasClientOptions
Returns
Promise
<
any
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
create
delete
get
get
All
update
npm
Atlas Admin API v2
mongodb-atlas-api-client
Loading...