Get Instance Info
GET/?<rate_limits>
Get information about the instance you’re sending this request to.
Most of this data comes from the instance’s configuration.
Query Params
| Name | Type |
|---|---|
| rate_limits | Boolean |
Response
200InstanceInfo
| Field | Type | Description |
|---|---|---|
| instance_name | String | The instance’s name. |
| description | String? | The instance’s description. This is between 1 and 2048 characters long. |
| version | String | The instance’s Eludris version. |
| message_limit | Number | The maximum length of a message’s content. |
| bio_limit | Number | The maximum length of a user’s bio. |
| oprish_url | String | The URL of the instance’s Oprish (REST API) endpoint. |
| pandemonium_url | String | The URL of the instance’s Pandemonium (WebSocket API) endpoint. |
| effis_url | String | The URL of the instance’s Effis (CDN) endpoint. |
| file_size | Number | The maximum file size (in bytes) of an asset. |
| attachment_file_size | Number | The maximum file size (in bytes) of an attachment. |
| email_address? | String | The instance’s email address if any. |
| rate_limits? | InstanceRateLimits | The rate limits that apply to the connected Eludris instance. This is not present if the rate_limits query parameter is not set. |
Example
curl https://api.eludris.gay/?rate_limits
{
"instance_name": "eludris",
"description": "The *almost* official Eludris instance - ooliver.",
"version": "0.3.2",
"message_limit": 2000,
"oprish_url": "https://api.eludris.gay",
"pandemonium_url": "wss://ws.eludris.gay/",
"effis_url": "https://cdn.eludris.gay",
"file_size": 20000000,
"attachment_file_size": 25000000,
"rate_limits": {
"oprish": {
"info": {
"reset_after": 5,
"limit": 2
},
"message_create": {
"reset_after": 5,
"limit": 10
}
},
"pandemonium": {
"reset_after": 10,
"limit": 5
},
"effis": {
"assets": {
"reset_after": 60,
"limit": 5,
"file_size_limit": 30000000
},
"attachments": {
"reset_after": 180,
"limit": 20,
"file_size_limit": 500000000
},
"fetch_file": {
"reset_after": 60,
"limit": 30
}
}
}
}