diff --git a/docs/api/making-requests.md b/docs/api/making-requests.md index 0936fd28..c0e657f9 100644 --- a/docs/api/making-requests.md +++ b/docs/api/making-requests.md @@ -8,14 +8,17 @@ The API is accessible from `http:///api/` You can use curl to interact with the API. There is no authentication required for `GET` requests: -`curl -XGET http://status.cachethq.io/api/components` +```bash +$ curl -XGET http://status.cachethq.io/api/components +``` In order to create incidents, you must send the a json string with the required payload and authenticate. More information can be found in the Endpoints documentation listed below. Here's a simple example: -`curl -u username@example.com -H "Content-Type: application/json" -d '{"name":"API","description":"An example description","status":1}' http://status.cachethq.io/api/components` - +```bash +$ curl -u username@example.com -H "Content-Type: application/json" -d '{"name":"API","description":"An example description","status":1}' http://status.cachethq.io/api/components +``` # Endpoints