From 90f081e63127e563944f428dc41cdbf563d0140a Mon Sep 17 00:00:00 2001 From: Hunter Long Date: Wed, 12 Sep 2018 09:48:06 -0700 Subject: [PATCH] Updated API (markdown) --- API.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/API.md b/API.md index 75a30c0..c36a82a 100644 --- a/API.md +++ b/API.md @@ -1,8 +1,14 @@ Statup includes a RESTFUL API so you can view, update, and edit your services with easy to use routes. +## Authentication + +HTTP Request Header: `Authorization: API SECRET HERE` + ## Main Route `/api` +The main API route will show you all services and failures along with them. ## Services +The services API endpoint will show you detailed information about services and will allow you to edit/delete services with POST/DELETE http methods. #### Viewing All Services - Endpoint: `/api/services` @@ -21,6 +27,7 @@ Statup includes a RESTFUL API so you can view, update, and edit your services wi - Method: `DELETE` ## Users +The users API endpoint will show you users that are registered inside your Statup instance. #### View All Users - Endpoint: `/api/users`