Instance
Rust instance API reference: typed methods, request options, return values, and resource models.
goodmem::api::Instance
Access this service with client.instance().
pub struct Instance<'a> {
/* private fields */
}Methods
| Method | HTTP | Path |
|---|---|---|
get | GET | /v1/instance |
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 Instance<'_>
get
pub async fn get(&self) ->Result<GoodMemInstance>
Get the GoodMem 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.
Errors include local validation, HTTP failures, and malformed responses.
HTTP: GET /v1/instance
Types
Trait implementations
Clone(derived)Copy(derived)Debug(derived)