---
title: "Get the Cluster ID Based on Name"
slug: "get-the-cluster-id-based-on-name"
tags: ["Reference", "IPS 10.1.10"]
updated: 2026-09-23T09:35:02Z
published: 2026-09-23T09:35:02Z
canonical: "docs.trellix.com/get-the-cluster-id-based-on-name"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trellix.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get the Cluster ID Based on Name
This URL retrieves the Trellix Virtual IPS cluster id based on name.
## Resource URL
POST /cloud/getclusterid
## Request Parameters
**URL Parameters**
None
**Payload Request Parameters**
| Field Name | Description | Data Type | Mandatory |
| --- | --- | --- | --- |
| name | Cluster name | String | Yes |
## Response Parameters
Following fields are returned:
| Field Name | Description | Data Type |
| --- | --- | --- |
| createdResourceId | The cluster id | Number |
## Example
**Request**
POST [https:///sdkapi/cloud/getclusterid](https://%3CNSM_IP%3E/sdkapi/getclusterid)
**Payload**
```
{
‘name’ : ‘clusterName’
}
```
**Response**
```
{
‘createdResourceId’ : 101
}
```
## Error Information
None