---
title: "Set Activity State"
method: PUT
path: "/v2/Pearl/{pearlId}/Active"
tags: ["Pearl"]
---

# Set Activity State

`PUT /v2/Pearl/{pearlId}/Active`

## Request

- Base URL: `https://api.nlpearl.ai`
- URL: `https://api.nlpearl.ai/v2/Pearl/{pearlId}/Active`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v2/Pearl/:pearlId/Active/put.ts> (a function with typed inputs; its response is checked against the schema)

Run or Pause a specific Pearl

## Path parameters

- `pearlId` string, required

## Request body

- SetActiveRequest: Defines the request structure for setting the active status of an entity.
  - `isActive` boolean, required: A boolean value that specifies the new active status of the entity. True activates the entity, while false deactivates it.

## Response `200`

The active state of the Pearl.

- integer: Here is the activity status `1 - Running` `2 - Paused` `3 - Suspended` `10 - TemporaryMaintenance`

## Other responses

- `400`: Error

---

[API](https://skmtc.dev/nlpearl/apis/nlpearl-client-api.md) - [All operations](https://skmtc.dev/nlpearl/apis/nlpearl-client-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nlpearl/apis/nlpearl-client-api/revisions/52d64fc5d6e9?raw)