# Check If Test Plan Is Running

#### `⚠️ This API will be available after 1.16.6 release.`

The endpoint allows users to check if a specific test plan is currently running. The user must provide the test plan ID to retrieve its running status.

***

### Endpoint Information

* **URL**: `<custom-env-url>/Testinium.RestApi/api/plans/{id}/checkIsRunning`
* **Method**: `GET`
* **Authentication**: `Bearer Token` is required

***

### Path Variables

| Parameter | Type     | Required | Description                             |
| --------- | -------- | -------- | --------------------------------------- |
| `id`      | `Object` | Yes      | The unique identifier of the test plan. |

***

### Response Body

Upon a successful request, the API returns a `CheckIsRunningResponse` object indicating whether the test plan is currently running.

```json
{
  "status": "SUCCESS",
  "running": true
}
```

| Field     | Type      | Description                                     |
| --------- | --------- | ----------------------------------------------- |
| `status`  | `String`  | The status of the request (`SUCCESS` or other). |
| `running` | `boolean` | Indicates whether the test plan is running.     |

***

### Error Codes

| HTTP Code | Error Message           | Description                                      |
| --------- | ----------------------- | ------------------------------------------------ |
| `404`     | `Plan not found`        | The specified test plan was not found.           |
| `500`     | `Internal Server Error` | An unexpected error occurred on the server side. |

***

### Example Request

```bash
curl --location --request GET '<custom-env-url>/Testinium.RestApi/api/plans/{id}/checkIsRunning' \
--header 'Authorization: Bearer <your_access_token>'
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://testinium.gitbook.io/testinium-enterprise/apis/enterprise-2.0/plan/check-if-test-plan-is-running.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.