Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quentg/httpstatus
A site monitoring site
https://github.com/quentg/httpstatus
api descartes httpstatus php-framework php73
Last synced: 2 months ago
JSON representation
A site monitoring site
- Host: GitHub
- URL: https://github.com/quentg/httpstatus
- Owner: QuentG
- Created: 2019-02-08T13:38:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-24T21:00:24.000Z (almost 6 years ago)
- Last Synced: 2024-10-12T12:40:59.718Z (3 months ago)
- Topics: api, descartes, httpstatus, php-framework, php73
- Language: PHP
- Homepage:
- Size: 517 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Httpstatus
## Presentation
This web application will check the status of any site with a refresh of the status every two minutes + a complete history, and if a site is K.O three times in a row then the admin will receive an email on his mailbox and no sending message if a message has already been sent to the site less than 2 hours ago #NoSpam.
It has an admin space (with connection in advance) that will allow to add sites / edit (url) and delete them.
This web application also has an API.
## Description
### Update status
Based on HTTP return codes. With 4 status:
- Inaccessible -> 4xx
- Server error -> 5xx
- Accessible -> 2xx
- Unable to join the server -> 999
## API
The site has an API that allows you to:
- List the sites
- Add a site
- Delete a site
- Consult the current status of a site
- View the history of a site
### Different routes
- Home : /api/
- List : '/api/list
- Add : /api/add
- Status : /api/status/{id}
- History : /api/history/{id}
- Delete : /api/delete/{id}
***
### Example of different requests made to the API
- /api/
```
{
'version': 1,
'list': 'http://example.fr/httpstatus/api/list/'
}
```
***
- /api/list
```
{
'version': 1,
'websites': [
{
'id': 973,
'url': 'http://toto.com',
'delete': 'http://example.fr/httpstatus/api/delete/973',
'status': 'http://example.fr/httpstatus/api/status/973',
'history': 'http://example.fr/httpstatus/api/history/973',
},
...
]
}
```
***
- /api/add
```
{
'success': true,
'id': 7269,
}
```
***
- /api/status/973
```
{
'id': 973,
'url': 'http://toto.com',
'status': {
'code': 200,
'at': '2019-02-01 10:00:12'
}
}
```
***
- /api/history/973
```
{
'id': 973,
'url': 'http://toto.com',
'status': [
{
'code': 200,
'at': '2019-01-10 10:00:11'
},
{
'code': 500,
'at': '2019-01-10 09:58:11'
},
{
'code': 200,
'at': '2019-01-10 09:56:11'
},
]
}
```
***
- /api/delete/973
```
{
'success': true,
'id': 973,
}
```
## Authors
**Developed by** - [Lucas Consejo](https://github.com/lucasconsejo) && [Quentin gans](https://github.com/QuentG).