Rust · 0.1.0

InstanceProfile

Application protocol schema. Field names and inherited descriptions are kept in their original language.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

GETGet Instance Profile/api/v1/instance/profile

Shape and fields

object

Instance profile message containing basic instance information.

Field	Type / requirement	Description
`version`	string	Version is the current version of instance.
`demo`	boolean	Demo indicates if the instance is in demo mode.
`instanceUrl`	string	Instance URL is the URL of the instance.
`admin`	allOf User	The first administrator who set up this instance, for display purposes. May be null on an instance that has lost all admins; use needs_setup to determine whether initial setup is actually required.
`commit`	string	Commit is the current build commit of instance.
`needsSetup`	boolean	NeedsSetup is true when the instance has no users yet and requires initial setup (creating the first admin account). Unlike a null admin, this stays false once any user exists, so an instance that has lost its admins is not mistaken for a fresh install.
`accessMode`	string (enum) `INSTANCE_ACCESS_MODE_UNSPECIFIED` · `INSTANCE_ACCESS_MODE_PRIVATE` · `INSTANCE_ACCESS_MODE_PUBLIC`	Access mode controls whether unauthenticated users may access instance content.
`challenge`	InstanceProfile_Challenge

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "Version is the current version of instance."
    },
    "demo": {
      "type": "boolean",
      "description": "Demo indicates if the instance is in demo mode."
    },
    "instanceUrl": {
      "type": "string",
      "description": "Instance URL is the URL of the instance."
    },
    "admin": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User"
        }
      ],
      "description": "The first administrator who set up this instance, for display purposes.\n May be null on an instance that has lost all admins; use needs_setup to\n determine whether initial setup is actually required."
    },
    "commit": {
      "type": "string",
      "description": "Commit is the current build commit of instance."
    },
    "needsSetup": {
      "type": "boolean",
      "description": "NeedsSetup is true when the instance has no users yet and requires initial\n setup (creating the first admin account). Unlike a null admin, this stays\n false once any user exists, so an instance that has lost its admins is not\n mistaken for a fresh install."
    },
    "accessMode": {
      "enum": [
        "INSTANCE_ACCESS_MODE_UNSPECIFIED",
        "INSTANCE_ACCESS_MODE_PRIVATE",
        "INSTANCE_ACCESS_MODE_PUBLIC"
      ],
      "type": "string",
      "description": "Access mode controls whether unauthenticated users may access instance content.",
      "format": "enum"
    },
    "challenge": {
      "$ref": "#/components/schemas/InstanceProfile_Challenge"
    }
  },
  "description": "Instance profile message containing basic instance information."
}