IndexApi

All URIs are relative to http://localhost

Method	HTTP request	Description
createExpiringIndex	PUT /mongodb/collections/{collectionName}/index/field/{fieldName}/{duration}/expiring	Create expiring Index by Field for Collection
createIndex	PUT /mongodb/collections/{collectionName}/index	Create Index for Collection
createIndexForField	PUT /mongodb/collections/{collectionName}/index/field/	Create Index by Field for Collection
createTextIndex	PUT /mongodb/collections/{collectionName}/index/field/{fieldName}/text	Create text index by field for collection
createUniqueIndex	PUT /mongodb/collections/{collectionName}/index/field/{fieldName}/unique	Create Unique Index
deleteIndex	DELETE /mongodb/collections/{collectionName}/index/	Delete Index
index	GET /mongodb/collections/{collectionName}/index/	Index for Collection
listIndices	GET /mongodb/collections/{collectionName}/index	List Indices for Collection

createExpiringIndex

IndexCreateResponse createExpiringIndex(collectionName, fieldName, duration, sortAscending, name)

Create expiring Index by Field for Collection

Create expiring Index by Field for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
fieldName	String	The field Name for your index	[default to null]
duration	String	Expiring Duration in format 15d (https://www.scala-lang.org/api/2.13.7/scala/concurrent/duration/Duration.html)	[default to 15d]
sortAscending	Boolean	Sort your index ascending	[optional] [default to true]
name	String	Name for your index	[optional] [default to null]

Return type

IndexCreateResponse

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

createIndex

IndexCreateResponse createIndex(collectionName, IndexCreateRequest)

Create Index for Collection

Create Index for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
IndexCreateRequest	IndexCreateRequest

Return type

IndexCreateResponse

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

createIndexForField

IndexCreateResponse createIndexForField(collectionName, fieldName, sortAscending, IndexOptionsRequest)

Create Index by Field for Collection

Create Index by Field for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
fieldName	String	The field Name for your index	[default to null]
sortAscending	Boolean	Sort your index ascending	[optional] [default to true]
IndexOptionsRequest	IndexOptionsRequest		[optional]

Return type

IndexCreateResponse

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

createTextIndex

IndexCreateResponse createTextIndex(collectionName, fieldName, IndexOptionsRequest)

Create text index by field for collection

Create text index by field for given collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
fieldName	String	The field Name for your index	[default to null]
IndexOptionsRequest	IndexOptionsRequest		[optional]

Return type

IndexCreateResponse

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, text/plain

createUniqueIndex

IndexCreateResponse createUniqueIndex(collectionName, fieldName, sortAscending, name)

Create Unique Index

Create Unique Index by Field for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
fieldName	String	The field Name for your index	[default to null]
sortAscending	Boolean	Sort your index ascending	[optional] [default to true]
name	String	Name for your index	[optional] [default to null]

Return type

IndexCreateResponse

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain

deleteIndex

IndexDropResponse deleteIndex(collectionName, indexName)

Delete Index

Delete Index by Name for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
indexName	String	The name of your Index	[default to null]

Return type

IndexDropResponse

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

index

MongoIndex index(collectionName, indexName)

Index for Collection

Index by Name for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]
indexName	String	The name of your Index	[default to null]

Return type

MongoIndex

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listIndices

List listIndices(collectionName)

List Indices for Collection

List all Indices for given Collection

Parameters

Name	Type	Description	Notes
collectionName	String	The name of your MongoDb Collection	[default to null]

Return type

List

Authorization

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json