Skip to content

Commit

Permalink
doc: API call example added
Browse files Browse the repository at this point in the history
  • Loading branch information
mojtaba-esk committed Nov 30, 2023
1 parent 6f4a111 commit 9627675
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,39 +69,45 @@ Please note that all the endpoints have to be prefixed with `/api/v1`.
- **Endpoint:** `/packetloss`
- `/start`
- **Method:** POST
- **Description:** Start packet loss simulation.
- **Description:** Start packetloss service.
- `/status`
- **Method:** GET
- **Description:** Get packet loss status.
- **Description:** Get packetloss status.
- `/stop`
- **Method:** POST
- **Description:** Stop packet loss simulation.
- **Description:** Stop packetloss service.

**example:**

```bash
curl -iX POST http://localhost:9007/api/v1/packetloss/start --data '{"network_interface":"eth0","packet_loss_rate":30}'
```

#### Bandwidth

- **Endpoint:** `/bandwidth`
- `/start`
- **Method:** POST
- **Description:** Start bandwidth simulation.
- **Description:** Start bandwidth service.
- `/status`
- **Method:** GET
- **Description:** Get bandwidth status.
- `/stop`
- **Method:** POST
- **Description:** Stop bandwidth simulation.
- **Description:** Stop bandwidth service.

#### Latency

- **Endpoint:** `/latency`
- `/start`
- **Method:** POST
- **Description:** Start latency simulation.
- **Description:** Start latency service.
- `/status`
- **Method:** GET
- **Description:** Get latency status.
- `/stop`
- **Method:** POST
- **Description:** Stop latency simulation.
- **Description:** Stop latency service.

#### Services

Expand Down

0 comments on commit 9627675

Please sign in to comment.