Skip to main content
POST
/
v2
/
Pearl
/
{pearlId}
/
Active
Set Activity State
curl --request POST \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "isActive": true
}'
123

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

Body

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

The active state of the Pearl.

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance