Admin API
Table of Contents
Section titled “Table of Contents”Services
Section titled “Services”| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| RegisterService | RegistryRequest | RegistryResponse | Register a remote agent or service |
| StartApplication | ApplicationRequest | StartResponse | Start a remote application |
| StartVM | StartVMRequest | StartResponse | Start a VM |
| StartService | StartServiceRequest | StartResponse | Start a remote service |
| PauseApplication | ApplicationRequest | ApplicationResponse | Pause (freeze) a remote application |
| ResumeApplication | ApplicationRequest | ApplicationResponse | Resume (un-freeze) a remote application |
| StopApplication | ApplicationRequest | ApplicationResponse | Stop a remote application |
| SetLocale | LocaleRequest | Empty | Set locale (broadcasted across system) |
| SetTimezone | TimezoneRequest | Empty | Set timezone (broadcasted across system) |
| Poweroff | Empty | Empty | System poweroff command |
| Reboot | Empty | Empty | System reboot command |
| Suspend | Empty | Empty | System suspend command |
| Wakeup | Empty | Empty | System wakeup command |
| GetUnitStatus | UnitStatusRequest | .systemd.UnitStatus | Get systemd unit status |
| GetStats | StatsRequest | .stats.StatsResponse | Get stats information |
| QueryList | Empty | QueryListResponse | Get list of monitored units |
| Watch | Empty | WatchItem | Get stream of monitored units |
Messages
Section titled “Messages”| Field | Type | Label | Description |
|---|---|---|---|
| AppName | string | Application name | |
| VmName | string | optional | Name of the VM hosting the application |
| Args | string | repeated | Application arguments |
| Field | Type | Label | Description |
|---|---|---|---|
| CmdStatus | string | Status of the RPC command | |
| AppStatus | string | Status of the application |
Empty message
| Field | Type | Label | Description |
|---|---|---|---|
| Locale | string | String with locale value. Format: X/Open Portability Guide / GNU libc. |
| Field | Type | Label | Description |
|---|---|---|---|
| Name | string | Name of the unit | |
| Description | string | Description of the unit | |
| VmStatus | string | Status of the VM hosting the unit | |
| TrustLevel | string | Trust Level (future use) | |
| VmType | string | Type of the VM (future use) | |
| ServiceType | string | Type of the service (future use) | |
| VmName | string | optional | Name of the VM to query; None for host running services |
| AgentName | string | optional | Name of the managing agent; None for agents |
| Field | Type | Label | Description |
|---|---|---|---|
| List | QueryListItem | repeated | List of query responses |
| Field | Type | Label | Description |
|---|---|---|---|
| Name | string | Component name for registry entry | |
| Parent | string | Parent component identifier (registry name) | |
| Type | uint32 | Component type | |
| Transport | TransportConfig | TransportConfig | |
| State | systemd.UnitStatus | Unit status of the component (systemd) |
| Field | Type | Label | Description |
|---|---|---|---|
| Error | string | optional | Error message |
| Field | Type | Label | Description |
|---|---|---|---|
| registryId | string | Registry ID for newly started app, service or vm |
| Field | Type | Label | Description |
|---|---|---|---|
| ServiceName | string | Name of the service to start | |
| VmName | string | Name of the VM hosting service |
| Field | Type | Label | Description |
|---|---|---|---|
| VmName | string | Name of the VM to start |
| Field | Type | Label | Description |
|---|---|---|---|
| VmName | string | VM name to query status information |
| Field | Type | Label | Description |
|---|---|---|---|
| Timezone | string | String with timezone value. Format: tz database name, usually Area/City or Etc/GMT+3. |
| Field | Type | Label | Description |
|---|---|---|---|
| Protocol | string | Protocol identifier, one of tcp, vsock, unix | |
| Address | string | IPv4 address, vsock CID, or unix socket path | |
| Port | string | Port number | |
| Name | string | Host name |
| Field | Type | Label | Description |
|---|---|---|---|
| VmName | string | Name of the VM hosting the unit | |
| UnitName | string | Name of the unit |
| Field | Type | Label | Description |
|---|---|---|---|
| Initial | QueryListResponse | ||
| Added | QueryListItem | ||
| Updated | QueryListItem | ||
| Removed | QueryListItem |
Scalar Value Types
Section titled “Scalar Value Types”| .proto Type | Notes | Go Type |
|---|---|---|
| double | float64 | |
| float | float32 | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 |
| uint32 | Uses variable-length encoding. | uint32 |
| uint64 | Uses variable-length encoding. | uint64 |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 |
| sfixed32 | Always four bytes. | int32 |
| sfixed64 | Always eight bytes. | int64 |
| bool | bool | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string |
| bytes | May contain any arbitrary sequence of bytes. | []byte |