Instance

Singleton instance identity and ownership.

Methods on this page are called through client.instance.

client.instance.get

client.instance.get(requestOptions?: RequestOptions): Promise<GoodMemInstanceResponseShape>

Returns singleton instance identity, ownership, and audit metadata after requiring effective READ_INSTANCE authority. The built-in ADMIN role supplies this authority; instance ownership alone does not. A scoped API key must also retain READ_INSTANCE in its immutable ceiling. This operation does not expose credentials or mutate instance state.

HTTP: GET /v1/instance

Parameters

Returns: Promise<GoodMemInstanceResponseShape>

Example

const currentInstance = await client.instance.get();
console.log(currentInstance.instanceId, currentInstance.ownerId);