GoodMemGoodMem
ReferenceClient SDKsRust

System

Rust system API reference: typed methods, request options, return values, and resource models.

goodmem::api::System

Access this service with client.system().

pub struct System<'a> {
    /* private fields */
}

Methods

MethodHTTPPath
infoGET/v1/system/info
initPOST/v1/system/init

Errors and cancellation

Calls return Result<T>. See Error for validation, HTTP, transport, decoding, and timeout failures. Stream items can also return errors after the call succeeds.

Pagination helpers fetch pages when polled. Drop a page or event stream to cancel further work.

Implementations

impl System<'_>

info

pub async fn info(&self) -> Result<SystemInfoResponse>

Retrieve server build metadata

Returns the server's advertised semantic version, git metadata, build timestamp, and optional capability flags. The endpoint is intentionally unauthenticated so bootstrap tooling can call it before API keys exist.

Errors include local validation, HTTP failures, and malformed responses.

HTTP: GET /v1/system/info

init

pub async fn init(&self) -> Result<SystemInitResponse>

Initialize the system

Initializes the system by creating a root user and API key. This endpoint should only be called once during first-time setup. If the system is already initialized, the endpoint will return a success response without creating new credentials.

Errors include local validation, HTTP failures, and malformed responses.

HTTP: POST /v1/system/init

Types

Trait implementations

  • Clone (derived)
  • Copy (derived)
  • Debug (derived)

On this page