v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Pearl

Set Activity State

Run or Pause a specific Pearl

put/v2/Pearl/{pearlId}/Active

Path parameters

pearlIdstring required

Request body

isActiveboolean 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.

integer required

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance