diff --git a/API.md b/API.md index 8d1cd29..a0517c9 100644 --- a/API.md +++ b/API.md @@ -134,15 +134,66 @@ Response: { "id": 5187, "issue": "HTTP Status Code 502 did not match 200", - "service_id": 8, "created_at": "2018-09-12T10:41:46.292277471-07:00" }, { "id": 5188, "issue": "HTTP Status Code 502 did not match 200", - "service_id": 8, "created_at": "2018-09-12T10:41:47.337659862-07:00" } ] } ``` + +# User Response +```json +{ + "id": 1, + "username": "admin", + "api_key": "02f324450a631980121e8fd6ea7dfe4a7c685a2f", + "admin": true, + "created_at": "2018-09-12T09:06:53.906398511-07:00", + "updated_at": "2018-09-12T09:06:54.972440207-07:00" +} +``` + +# Main API Response +```json +{ + "name": "Awesome Status", + "description": "An awesome status page by Statup", + "footer": "This is my custom footer", + "domain": "https://demo.statup.io", + "version": "v0.56", + "migration_id": 1536768413, + "created_at": "2018-09-12T09:06:53.905374829-07:00", + "updated_at": "2018-09-12T09:07:01.654201225-07:00", + "database": "sqlite", + "started_on": "2018-09-12T10:43:07.760729349-07:00", + "services": [ + { + "id": 1, + "name": "Google", + "domain": "https://google.com", + "expected": "", + "expected_status": 200, + "check_interval": 10, + "type": "http", + "method": "GET", + "post_data": "", + "port": 0, + "timeout": 10, + "order_id": 0, + "created_at": "2018-09-12T09:06:54.97549122-07:00", + "updated_at": "2018-09-12T09:06:54.975624103-07:00", + "online": true, + "latency": 0.09080986, + "24_hours_online": 0, + "avg_response": "", + "status_code": 200, + "last_online": "2018-09-12T10:44:07.931990439-07:00", + "dns_lookup_time": 0.005543935 + } + ] +} +```