Sign in
meta

Instance discovery, unauthenticated.

Changed on

The response is an exact closed allowlist: server version, API revision, and which authentication protocol flows this instance serves. Nothing tenant- or configuration-shaped — capability discovery beyond protocol selection happens after authentication.

Sits under the instance-wide pre-auth admission limits like every other pre-auth path.

get/api/v1/meta

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/meta
  • Auth: none required

Response

Instance metadata.

instance_identitystring

Stable server-generated instance identity, independent of URL aliases.

server_versionstring required

The build's version string; dev for unreleased builds.

api_revisioninteger required

This server's API revision. A client refuses an operation whose x-hikyo-min-revision exceeds it, naming the server version — a loud refusal, never a silent misbehave.

protocol_capabilitiesProtocolCapability[] required

Which protocols this instance serves: the authentication flows login needs before any session exists, and the machine protocols an integration probes before using them, such as delivery-target-report/<vocabulary> for each delivery-target report vocabulary this server accepts.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status