Relayer API

GET /manifest

How to find the latest encrypted manifest stored under a holder's locator.

GET /manifest returns the Irys id of the latest manifest stored under a locator. The locator is derived from the holder's signature, so a holder who connects on any device finds their vault: the browser fetches that ciphertext from the gateway and decrypts it to restore files. Notes are rebuilt from GET /tree. It is called right after the keys are derived, and on recovery. See The manifest.

Request

HTTP
GET /manifest?locator=0xc956aee6dbf6a2442867a786c697bc0ca45e59b45653d9dfc722ee0da73c0bca
Query
locatorrequired
Hash32
The holder's locator: 0x and 64 lowercase hex characters.

No other query keys are accepted.

Response

ManifestResponse
idrequired
IrysId | null
The Irys id of the latest manifest for the locator, or null when none has been stored.
storedAtrequired
Timestamp | null
The Irys timestamp of that manifest, or null.

A null pair is an answer, not an error: the holder has no vault yet, and the client starts an empty one.

Behaviour

A manifest is quoted, paid and stored with its locator (GET /quote, POST /pay, POST /upload); each such upload becomes the latest for that locator. The relayer asks Irys for the newest item tagged Geode-Locator with the locator, and learns only the locator and the ciphertext's id, never the manifest's contents.

The checks run in this order: the relayer is ready (PROGRAM_UNAVAILABLE), then the query schema (VALIDATION_ERROR), then the Irys lookup (IRYS_UNAVAILABLE when it fails).

Errors

Codes are explained in full under Errors.

CodeRaised whenNext
PROGRAM_UNAVAILABLEThe relayer is not ready. Retryable.Retry later.
VALIDATION_ERRORlocator is missing or not 0x and 64 lowercase hex characters, or the query has another key.Send the locator as derived.
IRYS_UNAVAILABLEThe Irys lookup failed. Retryable.Retry later.

Example

HTTP
GET /manifest?locator=0xc956aee6dbf6a2442867a786c697bc0ca45e59b45653d9dfc722ee0da73c0bca
Accept: application/json