49 lines
835 B
Markdown
49 lines
835 B
Markdown
# TestArena API Reference
|
|
|
|
## Base URL
|
|
`http://<server-ip>:8080/api`
|
|
|
|
## Endpoints
|
|
|
|
### 1. Submit a New Queue
|
|
`POST /queue`
|
|
Submits a new set of tasks to the execution queue.
|
|
**Payload:**
|
|
```json
|
|
{
|
|
"source": "branch_name",
|
|
"job_id": [
|
|
"environment",
|
|
{
|
|
"task_id": "scenario_path"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### 2. Get Status
|
|
`GET /status/{id}`
|
|
Gets the status of a specific queue or task.
|
|
|
|
### 3. Abort Queue or Task
|
|
`POST /abort/{id}`
|
|
Aborts a waiting or running queue or a single task.
|
|
|
|
### 4. Delete Queue
|
|
`DELETE /delete/{id}`
|
|
Permanently deletes a queue and its associated data.
|
|
|
|
## Local API (Web App)
|
|
|
|
### Get Job Details
|
|
`GET /jobs/{job_id}`
|
|
|
|
### Get Job Status (Triggers Update)
|
|
`GET /jobs/{job_id}/status`
|
|
|
|
### Abort Job
|
|
`POST /jobs/{job_id}/abort`
|
|
|
|
### Delete Job
|
|
`POST /jobs/{job_id}/delete`
|