---
title: Cluster activation
description: The openidm/cluster/active endpoint lets you read and set the cluster readiness state of an IDM instance.
component: pingidm
version: 8.1
page_id: pingidm:rest-api-reference:endpoints/rest-cluster-active
canonical_url: https://docs.pingidentity.com/pingidm/8.1/rest-api-reference/endpoints/rest-cluster-active.html
section_ids:
  endpoint_summary: Endpoint summary
  read_the_cluster_readiness_state: Read the cluster readiness state
  set_the_cluster_readiness_state: Set the cluster readiness state
  request_body: Request body
  authentication: Authentication
---

# Cluster activation

The `openidm/cluster/active` endpoint lets you read and set the cluster readiness state of an IDM instance.

This endpoint is available only when both `org.forgerock.feature.cluster.active.passive` and `org.forgerock.feature.cluster.improved` are set to `true` in `resolver/boot.properties`.

Learn more in [Cluster standby mode](../../install-guide/cluster-standby.html).

## Endpoint summary

| HTTP Operation | Endpoint                  | Description                                    |
| -------------- | ------------------------- | ---------------------------------------------- |
| GET            | `/openidm/cluster/active` | Read the current readiness state of this node. |
| PUT            | `/openidm/cluster/active` | Set the readiness state of this node.          |

## Read the cluster readiness state

```
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request GET \
'http://localhost:8080/openidm/cluster/active'
```

Example response

```json
{
  "state": "STANDBY"
}
```

## Set the cluster readiness state

To activate a node:

```
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request PUT \
--header "Accept-API-Version: resource=1.0" \
--header 'Content-Type: application/json' \
--header 'If-Match: *' \
--data '{"state":"ACTIVE"}' \
'http://localhost:8080/openidm/cluster/active'
```

Example response

```json
{
  "state": "ACTIVE"
}
```

To set a node to standby:

```
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request PUT \
--header "Accept-API-Version: resource=1.0" \
--header 'Content-Type: application/json' \
--header 'If-Match: *' \
--data '{"state":"STANDBY"}' \
'http://localhost:8080/openidm/cluster/active'
```

Example response

```json
{
  "state": "STANDBY"
}
```

## Request body

| Property | Type   | Description                                             |
| -------- | ------ | ------------------------------------------------------- |
| `state`  | String | The readiness state. Valid values: `ACTIVE`, `STANDBY`. |

## Authentication

Access to this endpoint is authenticated using credentials configured through the purpose `idm.cluster.activation.credentials`.

Learn more in [Store username and password as a secret](../../security-guide/secret-stores.html#store-user-pass-as-secret).