GoodMemGoodMem
ReferenceAPIREST APISystem

Get the GoodMem instance

GET /v1/instance: Returns singleton instance identity, ownership, and audit metadata after requiring effective READ_INSTANCE authority.

GET
/v1/instance

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.

Authorization

ApiKeyAuth
headerx-api-key<token>

Header Parameters

GoodMem-Timeout-Ms?integer

Optional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.

Formatint64
Range1 <= value <= 86400000

Response Body

Singleton instance metadata returned

application/json
  1. response

The singleton GoodMem instance and its ownership audit metadata.

instanceId*string

Durable UUID of the singleton GoodMem instance.

Formatuuid
Example"550e8400-e29b-41d4-a716-446655440000"
ownerId*string

Current human owner principal UUID.

Formatuuid
Example"650e8400-e29b-41d4-a716-446655440001"
createdAt*integer

Initialization timestamp in milliseconds since the Unix epoch.

Formatint64
Example1651483320000
updatedAt*integer

Most recent ownership-transfer timestamp in milliseconds since the Unix epoch.

Formatint64
Example1651486920000
createdById*string

Principal or API-key actor UUID that initialized the instance.

Formatuuid
Example"750e8400-e29b-41d4-a716-446655440002"
updatedById*string

Principal or API-key actor UUID that last transferred ownership.

Formatuuid
Example"850e8400-e29b-41d4-a716-446655440003"
Example Request
curl -X GET 'https://your-goodmem-server.example.com/v1/instance' \  -H 'GoodMem-Timeout-Ms: 30000'
Example Response
{  "instanceId": "550e8400-e29b-41d4-a716-446655440000",  "ownerId": "650e8400-e29b-41d4-a716-446655440001",  "createdAt": 1651483320000,  "updatedAt": 1651486920000,  "createdById": "750e8400-e29b-41d4-a716-446655440002",  "updatedById": "850e8400-e29b-41d4-a716-446655440003"}