Skip to content

Adding example of using the API endpoint #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding example of using the API endpoint #466

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,13 @@ All endpoints are JSON.
- **GET /version** - Returns the server version number
- **GET /metrics** - Returns Prometheus-compatible metrics

##### Example using the API Endpoints

```bash
$ curl -X POST -H "Content-Type: application/json" -d '{"enabled": false}' localhost:26913/proxies/shopify_development_memcached
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not clear why localhost:26913? Would it better to use default port?

{"name":"shopify_development_memcached","listen":"127.0.0.1:20915","upstream":"localhost:62070","enabled":false,"toxics":[]}%
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove the last character %, I think it is PROMT from shell.

```

#### Populating Proxies

Proxies can be added and configured in bulk using the `/populate` endpoint. This is done by
Expand Down