Interface InstanceInfo

Represents information about the connected Eludris instance.

Example

{
  "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
      },
      "rate_limits": {
        "reset_after": 5,
        "limit": 2
      }
    },
    "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
      }
    }
  }
}

Hierarchy

  • InstanceInfo

Properties

attachment_file_size description effis_url email_address? file_size instance_name message_limit oprish_url pandemonium_url rate_limits? version

Properties

attachment_file_size

attachment_file_size: number

The maximum file size (in bytes) of an attachment.

description

description: null | string

The instance's description.

This is between 1 and 2048 characters long.

effis_url

effis_url: string

The URL of the instance's Effis (CDN) endpoint.

Optional email_address

email_address?: null | string

The instance's email address if any.

file_size

file_size: number

The maximum file size (in bytes) of an asset.

instance_name

instance_name: string

The instance's name.

message_limit

message_limit: number

The maximum length of a message's content.

oprish_url

oprish_url: string

The URL of the instance's Oprish (REST API) endpoint.

pandemonium_url

pandemonium_url: string

The URL of the instance's Pandemonium (WebSocket API) endpoint.

Optional rate_limits

rate_limits?: null | InstanceRateLimits

The rate limits that apply to the connected Eludris instance.

This is not present if the rate_limits query parameter is not set.

version

version: string

The instance's Eludris version.

On This Page