GET /management/instances

This is used to return the list of all the merchant instances. It is only available for the implicit admin instance.

Required permission: instances-read

Response:

200 OK:

The backend has successfully returned the list of instances stored. Returns a InstancesResponse.

Details:

interface InstancesResponse {
  // List of instances that are present in the backend (see Instance).
  instances: Instance[];
}

The Instance object describes the instance registered with the backend. It does not include the full details, only those that usually concern the frontend. It has the following structure:

 interface Instance {
   // Merchant name corresponding to this instance.
   name: string;

   // Merchant public website.
   website?: string;

   // Merchant logo.
   logo?: ImageDataUrl;

   // Merchant instance this response is about ($INSTANCE).
   id: string;

   // Public key of the merchant/instance, in Crockford Base32 encoding.
   merchant_pub: EddsaPublicKey;

   // List of the payment targets supported by this instance. Clients can
   // specify the desired payment target in /order requests.  Note that
   // front-ends do not have to support wallets selecting payment targets.
   payment_targets: string[];

   // Has this instance been deleted (but not purged)?
   deleted: boolean;
}