Version v0.7 of the
documentation is no longer actively maintained. The site that you are
currently viewing is an archived snapshot.
For up-to-date documentation, see the
latest version.
API
Table of Contents
Top
health/health.proto
HealthCheck
HealthCheckResponse
HealthWatchRequest
| Field | Type | Label | Description |
|---|
| interval_seconds | int64 | | |
ReadyCheck
ReadyCheckResponse
| Field | Type | Label | Description |
|---|
| messages | ReadyCheck | repeated | |
HealthCheck.ServingStatus
| Name | Number | Description |
|---|
| UNKNOWN | 0 | |
| SERVING | 1 | |
| NOT_SERVING | 2 | |
ReadyCheck.ReadyStatus
| Name | Number | Description |
|---|
| UNKNOWN | 0 | |
| READY | 1 | |
| NOT_READY | 2 | |
Health
Top
machine/machine.proto
ApplyConfiguration
ApplyConfigurationResponse describes the response to a configuration request.
ApplyConfigurationRequest
rpc applyConfiguration
ApplyConfiguration describes a request to assert a new configuration upon a
node.
| Field | Type | Label | Description |
|---|
| data | bytes | | |
ApplyConfigurationResponse
Bootstrap
The bootstrap message containing the bootstrap status.
BootstrapRequest
rpc bootstrap
BootstrapResponse
| Field | Type | Label | Description |
|---|
| messages | Bootstrap | repeated | |
CPUInfo
CPUInfoResponse
| Field | Type | Label | Description |
|---|
| messages | CPUsInfo | repeated | |
CPUStat
CPUsInfo
Container
The messages message containing the requested containers.
ContainerInfo
The messages message containing the requested containers.
ContainersRequest
ContainersResponse
| Field | Type | Label | Description |
|---|
| messages | Container | repeated | |
CopyRequest
CopyRequest describes a request to copy data out of Talos node
Copy produces .tar.gz archive which is streamed back to the caller
| Field | Type | Label | Description |
|---|
| root_path | string | | Root path to start copying data out, it might be either a file or directory |
DiskStat
DiskStats
DiskStatsResponse
| Field | Type | Label | Description |
|---|
| messages | DiskStats | repeated | |
DiskUsageInfo
DiskUsageInfo describes a file or directory’s information for du command
| Field | Type | Label | Description |
|---|
| metadata | common.Metadata | | |
| name | string | | Name is the name (including prefixed path) of the file or directory |
| size | int64 | | Size indicates the number of bytes contained within the file |
| error | string | | Error describes any error encountered while trying to read the file information. |
| relative_name | string | | RelativeName is the name of the file or directory relative to the RootPath |
DiskUsageRequest
DiskUsageRequest describes a request to list disk usage of directories and regular files
| Field | Type | Label | Description |
|---|
| recursion_depth | int32 | | RecursionDepth indicates how many levels of subdirectories should be recursed. The default (0) indicates that no limit should be enforced. |
| all | bool | | All write sizes for all files, not just directories. |
| threshold | int64 | | Threshold exclude entries smaller than SIZE if positive, or entries greater than SIZE if negative. |
| paths | string | repeated | DiskUsagePaths is the list of directories to calculate disk usage for. |
DmesgRequest
dmesg
| Field | Type | Label | Description |
|---|
| follow | bool | | |
| tail | bool | | |
EtcdForfeitLeadership
EtcdForfeitLeadershipRequest
EtcdForfeitLeadershipResponse
EtcdLeaveCluster
EtcdLeaveClusterRequest
EtcdLeaveClusterResponse
EtcdMemberList
EtcdMemberListRequest
EtcdMemberListResponse
Event
EventsRequest
FileInfo
FileInfo describes a file or directory’s information
| Field | Type | Label | Description |
|---|
| metadata | common.Metadata | | |
| name | string | | Name is the name (including prefixed path) of the file or directory |
| size | int64 | | Size indicates the number of bytes contained within the file |
| mode | uint32 | | Mode is the bitmap of UNIX mode/permission flags of the file |
| modified | int64 | | Modified indicates the UNIX timestamp at which the file was last modified |
TODO: unix timestamp or include proto’s Date type |
| is_dir | bool | | IsDir indicates that the file is a directory |
| error | string | | Error describes any error encountered while trying to read the file information. |
| link | string | | Link is filled with symlink target |
| relative_name | string | | RelativeName is the name of the file or directory relative to the RootPath |
Hostname
HostnameResponse
| Field | Type | Label | Description |
|---|
| messages | Hostname | repeated | |
ListRequest
ListRequest describes a request to list the contents of a directory
| Field | Type | Label | Description |
|---|
| root | string | | Root indicates the root directory for the list. If not indicated, ‘/’ is presumed. |
| recurse | bool | | Recurse indicates that subdirectories should be recursed. |
| recursion_depth | int32 | | RecursionDepth indicates how many levels of subdirectories should be recursed. The default (0) indicates that no limit should be enforced. |
LoadAvg
LoadAvgResponse
| Field | Type | Label | Description |
|---|
| messages | LoadAvg | repeated | |
LogsRequest
rpc logs
The request message containing the process name.
MemInfo
Memory
MemoryResponse
| Field | Type | Label | Description |
|---|
| messages | Memory | repeated | |
MountStat
The messages message containing the requested processes.
Mounts
The messages message containing the requested df stats.
MountsResponse
| Field | Type | Label | Description |
|---|
| messages | Mounts | repeated | |
NetDev
NetworkDeviceStats
NetworkDeviceStatsResponse
PhaseEvent
Process
ProcessInfo
ProcessesRequest
rpc processes
ProcessesResponse
| Field | Type | Label | Description |
|---|
| messages | Process | repeated | |
ReadRequest
| Field | Type | Label | Description |
|---|
| path | string | | |
Reboot
rpc reboot
The reboot message containing the reboot status.
RebootResponse
| Field | Type | Label | Description |
|---|
| messages | Reboot | repeated | |
Recover
The recover message containing the recover status.
RecoverRequest
RecoverResponse
| Field | Type | Label | Description |
|---|
| messages | Recover | repeated | |
Reset
The reset message containing the restart status.
ResetRequest
rpc reset
| Field | Type | Label | Description |
|---|
| graceful | bool | | |
| reboot | bool | | |
ResetResponse
| Field | Type | Label | Description |
|---|
| messages | Reset | repeated | |
Restart
RestartRequest
rpc restart
The request message containing the process to restart.
RestartResponse
The messages message containing the restart status.
| Field | Type | Label | Description |
|---|
| messages | Restart | repeated | |
Rollback
RollbackRequest
rpc rollback
RollbackResponse
| Field | Type | Label | Description |
|---|
| messages | Rollback | repeated | |
SequenceEvent
rpc events
ServiceEvent
ServiceEvents
ServiceHealth
ServiceInfo
ServiceList
rpc servicelist
ServiceListResponse
ServiceRestart
ServiceRestartRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
ServiceRestartResponse
ServiceStart
ServiceStartRequest
rpc servicestart
| Field | Type | Label | Description |
|---|
| id | string | | |
ServiceStartResponse
ServiceStateEvent
ServiceStop
ServiceStopRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
ServiceStopResponse
Shutdown
rpc shutdown
The messages message containing the shutdown status.
ShutdownResponse
| Field | Type | Label | Description |
|---|
| messages | Shutdown | repeated | |
SoftIRQStat
StartRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
StartResponse
| Field | Type | Label | Description |
|---|
| resp | string | | |
Stat
The messages message containing the requested stat.
Stats
The messages message containing the requested stats.
StatsRequest
The request message containing the containerd namespace.
StatsResponse
| Field | Type | Label | Description |
|---|
| messages | Stats | repeated | |
StopRequest
| Field | Type | Label | Description |
|---|
| id | string | | |
StopResponse
| Field | Type | Label | Description |
|---|
| resp | string | | |
SystemStat
SystemStatResponse
| Field | Type | Label | Description |
|---|
| messages | SystemStat | repeated | |
TaskEvent
Upgrade
UpgradeRequest
rpc upgrade
UpgradeResponse
| Field | Type | Label | Description |
|---|
| messages | Upgrade | repeated | |
Version
VersionInfo
VersionResponse
| Field | Type | Label | Description |
|---|
| messages | Version | repeated | |
PhaseEvent.Action
| Name | Number | Description |
|---|
| START | 0 | |
| STOP | 1 | |
RecoverRequest.Source
| Name | Number | Description |
|---|
| ETCD | 0 | |
| APISERVER | 1 | |
SequenceEvent.Action
| Name | Number | Description |
|---|
| NOOP | 0 | |
| START | 1 | |
| STOP | 2 | |
ServiceStateEvent.Action
| Name | Number | Description |
|---|
| INITIALIZED | 0 | |
| PREPARING | 1 | |
| WAITING | 2 | |
| RUNNING | 3 | |
| STOPPING | 4 | |
| FINISHED | 5 | |
| FAILED | 6 | |
| SKIPPED | 7 | |
TaskEvent.Action
| Name | Number | Description |
|---|
| START | 0 | |
| STOP | 1 | |
MachineService
The machine service definition.
MaintenanceService
Top
network/network.proto
Interface
Interface represents a net.Interface
Interfaces
InterfacesResponse
| Field | Type | Label | Description |
|---|
| messages | Interfaces | repeated | |
Route
The messages message containing a route.
| Field | Type | Label | Description |
|---|
| interface | string | | Interface is the interface over which traffic to this destination should be sent |
| destination | string | | Destination is the network prefix CIDR which this route provides |
| gateway | string | | Gateway is the gateway address to which traffic to this destination should be sent |
| metric | uint32 | | Metric is the priority of the route, where lower metrics have higher priorities |
| scope | uint32 | | Scope desribes the scope of this route |
| source | string | | Source is the source prefix CIDR for the route, if one is defined |
| family | AddressFamily | | Family is the address family of the route. Currently, the only options are AF_INET (IPV4) and AF_INET6 (IPV6). |
| protocol | RouteProtocol | | Protocol is the protocol by which this route came to be in place |
| flags | uint32 | | Flags indicate any special flags on the route |
Routes
RoutesResponse
The messages message containing the routes.
| Field | Type | Label | Description |
|---|
| messages | Routes | repeated | |
AddressFamily
| Name | Number | Description |
|---|
| AF_UNSPEC | 0 | |
| AF_INET | 2 | |
| IPV4 | 2 | |
| AF_INET6 | 10 | |
| IPV6 | 10 | |
InterfaceFlags
| Name | Number | Description |
|---|
| FLAG_UNKNOWN | 0 | |
| FLAG_UP | 1 | |
| FLAG_BROADCAST | 2 | |
| FLAG_LOOPBACK | 3 | |
| FLAG_POINT_TO_POINT | 4 | |
| FLAG_MULTICAST | 5 | |
RouteProtocol
| Name | Number | Description |
|---|
| RTPROT_UNSPEC | 0 | |
| RTPROT_REDIRECT | 1 | Route installed by ICMP redirects |
| RTPROT_KERNEL | 2 | Route installed by kernel |
| RTPROT_BOOT | 3 | Route installed during boot |
| RTPROT_STATIC | 4 | Route installed by administrator |
| RTPROT_GATED | 8 | Route installed by gated |
| RTPROT_RA | 9 | Route installed by router advertisement |
| RTPROT_MRT | 10 | Route installed by Merit MRT |
| RTPROT_ZEBRA | 11 | Route installed by Zebra/Quagga |
| RTPROT_BIRD | 12 | Route installed by Bird |
| RTPROT_DNROUTED | 13 | Route installed by DECnet routing daemon |
| RTPROT_XORP | 14 | Route installed by XORP |
| RTPROT_NTK | 15 | Route installed by Netsukuku |
| RTPROT_DHCP | 16 | Route installed by DHCP |
| RTPROT_MROUTED | 17 | Route installed by Multicast daemon |
| RTPROT_BABEL | 42 | Route installed by Babel daemon |
NetworkService
The network service definition.
Top
os/os.proto
OSService
The OS service definition.
Deprecated: this API is deprecated and merged into Machine API.
Top
security/security.proto
CertificateRequest
The request message containing the process name.
| Field | Type | Label | Description |
|---|
| csr | bytes | | |
CertificateResponse
The response message containing the requested logs.
ReadFileRequest
The request message for reading a file on disk.
| Field | Type | Label | Description |
|---|
| path | string | | |
ReadFileResponse
The response message for reading a file on disk.
| Field | Type | Label | Description |
|---|
| data | bytes | | |
WriteFileRequest
The request message containing the process name.
WriteFileResponse
The response message containing the requested logs.
SecurityService
The security service definition.
Top
time/time.proto
Time
TimeRequest
The response message containing the ntp server
| Field | Type | Label | Description |
|---|
| server | string | | |
TimeResponse
The response message containing the ntp server, time, and offset
| Field | Type | Label | Description |
|---|
| messages | Time | repeated | |
TimeService
The time service definition.
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|
| double | | double | double | float | float64 | double | float | Float |
| float | | float | float | float | float32 | float | float | Float |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |