instance

One connection entry, full detail, fetched on view.

Changed on
get/api/v1/instance/remotes/{remote}

Request

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

Response

The entry with its last-known state.

idstring required

A prefixed UUIDv7, e.g. org_0198….

namestring required

A display name for an organisation, project or environment. Identity is the immutable id, so this is a label and a rename never breaks a reference. The 128-byte bound is the one the organisation contract has carried since the first slice, adopted for every entity so there is one number rather than four; no ADR fixes a per-entity name length. The grammar itself (non-empty, no control characters, no surrounding whitespace) is enforced in the domain rather than restated as a pattern here — two grammars would be two things to keep in sync.

The bound is 128 UTF-8 BYTES, and the server is authoritative. maxLength below counts Unicode code points, which is the only length JSON Schema can express, so a name of 100 emoji satisfies this schema and is still refused by the server with bad_request. Clients that want to pre-validate must measure the UTF-8 encoding, not the string length.

urlstring required

The canonical https origin. Immutable for the life of the entry.

spki_pinstring required

base64(sha256(SubjectPublicKeyInfo)), confirmed by a human at add time and verified on every connection before any bytes are written. Immutable for the life of the entry.

created_atstring date-time required

RFC 3339 UTC, microsecond precision.

created_bystring required
state'ok' | 'unreachable' | 'credential-rejected' | 'pin-mismatch' | 'redirect-refused' | 'identity-conflict' | 'self-connected' required

The most recent fetch's outcome. A closed enum because the operator's fix differs per outcome, and collapsing them into one "error" is what makes a directory card useless.

last_attempt_atstring date-time required

RFC 3339 UTC, microsecond precision.

observed_atstring date-time

RFC 3339 UTC, microsecond precision.

staleboolean required

The listing below is a SNAPSHOT, not current. Computed from the outcome rather than the age: a fetch that just failed makes even a one-second-old snapshot stale.

stale_for_secondsinteger

The snapshot's age, the number the card prints beside "unreachable".

identitystring
versionstring
org_countinteger
project_countinteger

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