API v2 Docs - Status Endpoint

The status endpoints allows reading status info of the DisCal network. This includes, but is not limited to showing uptime, memory usage, shard status, and more



status/get

Returns the status data.

A request body is not required for this endpoint.


Example Request Body

				{}
				

Example Response


				{
				"api_uptime": "0 months, 5 days, 3 hours, 43 minutes, 16 seconds",
				"announcements": 8534,
				"total_guilds": 11509,
				"calendars: 21367,
				"clients": [{
					"index": 0,
					"guilds": 1642,
					"keep_alive": 1575934181,
					"uptime": "0 months, 2 days, 3 hours, 12 minutes, 56 seconds",
					"memory": 502.12
					},
					{
					"index": 1,
					"guilds": 1543,
					"keep_alive": 1575936181,
					"uptime": "0 months, 8 days, 6 hours, 34 minutes, 27 seconds",
					"memory": 283.94
				}]
				}
				

Supported Values in Request
Key Value Type Info Required

Returned Values
Key Value Type Info
api_uptime String How long the API instance has been online
announcements int Total amount of announcements across the DisCal network
total_guilds int Total amount of guilds connected to DisCal
calendars int Total amount of calendars managed by DisCal
clients JSON Array An array of data pertaining to each individual DisCal Shard
clients.index int The index of the shard
clients.guilds int Total amount of guilds connected to this shard
clients.keep_alive long The unix timestamp of the last keep alive recorded by the API from this shard
clients.uptime String How long this shard has been online
clients.memory double Memory usage of this shard, in Megabytes