Basic
The basic routes of the API
GET /v1/help
Get a help message.
Example Response
- 200
- 500
- 503
Please refer to the wiki at https://wiki.jonasjones.dev/Api/
{
"status": 500,
"statusText": "Internal Server Error"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
API is down
{
"status": 503,
"statusText": "Service Unavailable"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
GET /v1/ping
Get a ping back from the API
Example Response
- 200
- 500
- 503
pong
{
"status": 500,
"statusText": "Internal Server Error"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
API is down
{
"status": 503,
"statusText": "Service Unavailable"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
GET /v1/version
Get the version of the Rust api back-end
Example Response
- 200
- 500
- 503
["0.0.1+alpha-build01"]
{
"status": 500,
"statusText": "Internal Server Error"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
API is down
{
"status": 503,
"statusText": "Service Unavailable"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
GET /v1/debug/headers
Get the incoming headers of the request
Example Response
- 200
- 500
- 503
{
"Origin": "...",
"Referer": "...",
"User-Agent": "...",
"...": "..."
}
{
"status": 500,
"statusText": "Internal Server Error"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |
API is down
{
"status": 503,
"statusText": "Service Unavailable"
}
Parameter | Type | Description |
---|---|---|
status | Number | The status code of the error |
statusText | String | The status text of the error |