Skip to content
Versiav0.7.0

Instance Metadata

Contains metadata about a Versia instance, such as its capabilities and public key. It is served by the instance it describes, has no id, and needs no signature, so that other instances can read the public key from it.

Definition

Type
"InstanceMetadata"
Fetch
GET /.versia/v0.7/instance
Collections

Fields

name string Required

Friendly name of the instance, for humans.

software Software Required

Information about the software running the instance.

name string Required

Name of the software.

version string Required

Version of the software. SHOULD use SemVer.

compatibility Compatibility Required

Information about the compatibility of the instance. Supported Versia Protocol versions are listed at the well-known endpoint.

extensions string[] Required

Supported extensions, each with its version, such as pub.versia:likes@1. MUST include every extension that a listed one requires.

description string

Long description of the instance, for humans.

domain Domain Required

Domain of the instance, used for federation.

public_key PublicKey Required

Public key of the instance.

algorithm string Required

Algorithm used for the public key. MUST be ed25519.

key string Required

Instance public key, in SPKI-encoded base64.

banner Media

Banner of the instance. MUST be an image (image/*).

Inherited from Entity: type, created_at, extensions
{
    "type": "InstanceMetadata",
    "name": "Jim's Jolly Jimjams",
    "software": {
        "name": "Versia Server",
        "version": "1.2.0-beta.3"
    },
    "compatibility": {
        "extensions": [
            "pub.versia:social@1",
            "pub.versia:reactions@1",
            "pub.versia:polls@1",
            "pub.versia:reports@1"
        ]
    },
    "description": "Server for Jim's Jolly Jimjams, a social network for fans of Jimjams.",
    "domain": "social.example",
    "public_key": {
        "algorithm": "ed25519",
        "key": "MCowBQYDK2VwAyEA9zhEMtQZetRl4QrLcz99i7jOa6ZVjX7aLfRUsMuKByI="
    },
    "logo": {
        "url": "https://social.example/files/logo.webp",
        "media_type": "image/webp"
    },
    "created_at": "2021-07-01T00:00:00Z",
    "extensions": {
        "com.example:stats": {
            "monthly_active_users": 1000
        }
    }
}