Maintenance
Every registered maintenance instance operation, with source-derived inputs, outputs, access policy, and errors.
This reference covers 9 HTTP operations registered by the Akasha daemon. Call these paths on your instance base URL. See authentication, errors, and coverage before integrating.
| Method | Path | Operation |
|---|---|---|
POST | /v1/backups | Backup create |
POST | /v1/backups/list | Backup list |
POST | /v1/backups/restore | Backup restore |
POST | /v1/backups/delete | Backup delete |
POST | /v1/analyze | Analyze |
POST | /v1/compact | Compact |
POST | /v1/reindex | Reindex |
POST | /v1/clear_cache | Clear cache |
POST | /v1/search/text | Core text search |
POST /v1/backups
Backup create
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
Json — BackupCreateRequest
| Field | Rust type | Required on input | Notes |
|---|---|---|---|
backup_dir | String | Yes | |
options | Option<akasha::CoreBackupOptions> | No; optional or defaulted | Serde: default |
struct BackupCreateRequest {
backup_dir: String,
#[serde(default)]
options: Option<akasha::CoreBackupOptions>,
}Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::to_value(info).unwrap_or(serde_json::json!({"ok":true})),Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3067. Registration: akasha-daemon/src/main.rs:4594.
POST /v1/backups/list
Backup list
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
Json — BackupListRequest
| Field | Rust type | Required on input | Notes |
|---|---|---|---|
backup_dir | String | Yes |
struct BackupListRequest {
backup_dir: String,
}Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::to_value(list).unwrap_or(serde_json::json!([])),Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3088. Registration: akasha-daemon/src/main.rs:4595.
POST /v1/backups/restore
Backup restore
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
Json — BackupRestoreRequest
| Field | Rust type | Required on input | Notes |
|---|---|---|---|
backup_dir | String | Yes | |
id | String | Yes | |
options | Option<akasha::CoreRestoreOptions> | No; optional or defaulted | Serde: default |
struct BackupRestoreRequest {
backup_dir: String,
id: String,
#[serde(default)]
options: Option<akasha::CoreRestoreOptions>,
}Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::json!({"ok": true})Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3111. Registration: akasha-daemon/src/main.rs:4596.
POST /v1/backups/delete
Backup delete
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
Json — BackupDeleteRequest
| Field | Rust type | Required on input | Notes |
|---|---|---|---|
backup_dir | String | Yes | |
id | String | Yes |
struct BackupDeleteRequest {
backup_dir: String,
id: String,
}Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::json!({"ok": true})Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3130. Registration: akasha-daemon/src/main.rs:4597.
POST /v1/analyze
Analyze
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
No typed JSON, query, or path extractor is declared in the handler signature. Headers or request objects may still be consumed; the signature below is authoritative.
Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::to_value(a).unwrap_or(serde_json::json!({})),Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3305. Registration: akasha-daemon/src/main.rs:4598.
POST /v1/compact
Compact
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
No typed JSON, query, or path extractor is declared in the handler signature. Headers or request objects may still be consumed; the signature below is authoritative.
Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::json!({"ok": true})Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3319. Registration: akasha-daemon/src/main.rs:4599.
POST /v1/reindex
Reindex
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
Json — ReindexRequest
| Field | Rust type | Required on input | Notes |
|---|---|---|---|
keyspace | String | Yes |
struct ReindexRequest {
keyspace: String,
}Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::json!({"ok": true})Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3340. Registration: akasha-daemon/src/main.rs:4600.
POST /v1/clear_cache
Clear cache
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
No typed JSON, query, or path extractor is declared in the handler signature. Headers or request objects may still be consumed; the signature below is authoritative.
Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::json!({"ok": true})Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3362. Registration: akasha-daemon/src/main.rs:4601.
POST /v1/search/text
Core text search
| Availability | Source contract |
|---|---|
| Registration | config.enable_kv || config.enable_analytics |
| Runtime service | No prefix-level service check; handler dependencies still apply. |
| Handler dependencies | See handler source and return expressions. |
Access: Daemon authentication and capability namespace authority; memory-domain permissions apply where mapped.
Request
Json — CoreTextSearchRequest
| Field | Rust type | Required on input | Notes |
|---|---|---|---|
keyspace | String | Yes | |
query | String | Yes | |
limit | Option<usize> | No; optional or defaulted |
struct CoreTextSearchRequest {
keyspace: String,
query: String,
limit: Option<usize>,
}Response
Declared return: Result<impl IntoResponse, DaemonError>
The following are the exact JSON construction expressions in the handler. Values such as rows, result, and delegated types are runtime values, not literal example payloads.
serde_json::json!({"rows": rows})Errors and validation
Directly referenced error variants: InvalidRequest. Middleware and delegated services can return additional errors described in the shared error reference.
Source: akasha-daemon/src/main.rs:3380. Registration: akasha-daemon/src/main.rs:4602.