Return All Search Nodes

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment

Copy endpoint

https://cloud.mongodb.com

Returns the Search Nodes for the specified cluster.

Parameters

path Path Parameters

Name Type

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 Label that identifies the cluster to return the Search Nodes for.	string

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

Label that identifies the cluster to return the Search Nodes for.

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 ApiSearchDeploymentResponseView {
encryptionAtRestProvider?: "NONE" | "AWS" | "AZURE" | "GCP";
groupId?: string;
id?: string;
specs?: readonly

ApiSearchDeploymentSpecView

interface ApiSearchDeploymentSpecView {
instanceSize: "S20_HIGHCPU_NVME" | "S30_HIGHCPU_NVME" | "S40_HIGHCPU_NVME" | "S50_HIGHCPU_NVME" | "S60_HIGHCPU_NVME" | "S70_HIGHCPU_NVME" | "S80_HIGHCPU_NVME" | "S30_LOWCPU_NVME" | "S40_LOWCPU_NVME" | "S50_LOWCPU_NVME" | "S60_LOWCPU_NVME" | "S70_LOWCPU_NVME" | "S80_LOWCPU_NVME" | "S90_LOWCPU_NVME" | "S100_LOWCPU_NVME" | "S110_LOWCPU_NVME" | "S120_LOWCPU_NVME" | "S130_LOWCPU_NVME" | "S135_LOWCPU_NVME" | "S140_LOWCPU_NVME" | "S40_STORAGE_NVME" | "S50_STORAGE_NVME" | "S60_STORAGE_NVME" | "S80_STORAGE_NVME" | "S90_STORAGE_NVME";
nodeCount: number;
}

[];
stateName?: "IDLE" | "PAUSED" | "UPDATING";
}

Client Errors

400 application/json

Bad Request.

interface ApiError {
badRequestDetail?:

BadRequestDetail

Bad request detail.

interface BadRequestDetail {
fields?: FieldViolation[];
}

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

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;
}