Return One Atlas Search Index

Deprecated

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}

Copy endpoint

https://cloud.mongodb.com

Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role.

Parameters

path Path Parameters

Name	Type
`groupId` required Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.	string
`clusterName` required Name of the cluster that contains the collection with one or more Atlas Search indexes.	string
`indexId` required Unique 24-hexadecimal digit string that identifies the Application Search index. Use the Get All Application Search Indexes for a Collection API endpoint to find the IDs of all Application Search indexes.	string

query Query Parameters

Name	Type
`envelope` Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.	boolean
`pretty` Flag that indicates whether the response body should be in the prettyprint format.	boolean

Responses

200 application/vnd.atlas.2023-01-01+json

interface ClusterSearchIndex {
collectionName: string;
database: string;
indexID?: string;
name: string;
numPartitions?: number;
status?: "IN_PROGRESS" | "STEADY" | "FAILED" | "MIGRATING" | "STALE" | "PAUSED";
storedSource?: {};
type?: "search" | "vectorSearch";
}

Client Errors

401 application/json

Unauthorized.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

403 application/json

Forbidden.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

404 application/json

Not Found.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}

Server Errors

500 application/json

Internal Server Error.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

;
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}