Sign in
instance

This instance's directory listing, as served to a connected instance.

Changed on

The ONE endpoint an instance-connection credential may reach. Artifact eligibility caps the credential to this operation alone, so a future operation adopting the instance-directory formula does not widen any existing token.

What it returns, exhaustively: this instance's opaque identity, its version, and the NAMES and counts of organisations and projects. No values, no keys, no environments, no membership, no settings, no audit — the response schema has no field that could carry one.

The identity is returned ONLY here, never pre-authentication. That is what makes self-connection detectable at the fetch rather than guessable from outside.

Human holders of instance-directory reach it too: it is the same listing, and hiding it from the humans the atom exists for would be arbitrary.

get/api/v1/instance/directory

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/directory
  • Auth: HTTP bearer

Response

The served listing.

identitystring required

This instance's opaque, server-generated identity, minted with the schema and preserved by backup/restore — a restored instance IS the instance. Returned ONLY here, never pre-authentication.

versionstring required

Display only. It never feeds a compatibility decision: a snapshot can race a downgrade or a restore, so the shell reads the pre-auth meta endpoint live for that.

org_countinteger required
project_countinteger required

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

    • 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 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

    • 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