Skip to content
Getting StartedReference

Get application status

GET
/api/status
curl --request GET \
--url https://example.com/api/status

Returns the health status of the application’s dependencies, including the database, Elasticsearch, Redis, workers, MobSF, MalwareBazaar and VirusTotal.

  • None
Media typeapplication/json
object
message
required
string
status
required
object
db
required
object
status
required
boolean
message
required
string
elasticsearch
required
object
status
required
boolean
message
required
string
redis
required
object
status
required
boolean
message
required
string
django_q_workers
required

Django Q worker statuses, indexed by cluster ID.

object
key
additional properties
string
mobsf
required
object
status
required
boolean
message
required
string
malware_bazaar_api_connection
required
object
status
required
boolean
message
required
string
virustotal_api_connection
required
object
status
required
boolean
message
required
string

Example generated

{
"message": "example",
"status": {
"db": {
"status": true,
"message": "example"
},
"elasticsearch": {
"status": true,
"message": "example"
},
"redis": {
"status": true,
"message": "example"
},
"django_q_workers": {
"additionalProperty": "example"
},
"mobsf": {
"status": true,
"message": "example"
},
"malware_bazaar_api_connection": {
"status": true,
"message": "example"
},
"virustotal_api_connection": {
"status": true,
"message": "example"
}
}
}