package proto

Get desktop application:
View/edit binary Protocol Buffers messages

rpc Version (Empty, VersionResponse)
control_v1.proto:113
Fetches the currently running version of the Elastic Agent.
message VersionResponse
control_v1.proto:41
Version response message.
- string version = 1
  Current running version.
- string commit = 2
  Current running commit.
- string buildTime = 3
  Current running build time.
- bool snapshot = 4
  Current running version is a snapshot.
rpc Status (Empty, StatusResponse)
control_v1.proto:116
Fetches the currently status of the Elastic Agent.
message StatusResponse
control_v1.proto:102
Status is the current status of Elastic Agent.
- Status status = 1
  Overall status of Elastic Agent.
- string message = 2
  Overall status message of Elastic Agent.
- repeated ApplicationStatus applications = 3
  Status of each application in Elastic Agent.
rpc Restart (Empty, RestartResponse)
control_v1.proto:119
Restart restarts the current running Elastic Agent.
message RestartResponse
control_v1.proto:52
- ActionStatus status = 1
  Response status.
- string error = 2
  Error message when it fails to trigger restart.
rpc Upgrade (UpgradeRequest, UpgradeResponse)
control_v1.proto:122
Upgrade starts the upgrade process of Elastic Agent.
message UpgradeRequest
control_v1.proto:60
Upgrade request message.
- string version = 1
  (Optional) Version to upgrade to. If not provided Elastic Agent will auto discover the latest version in the same major to upgrade to. If wanting to upgrade to a new major that major must be present in the this version field.
- string sourceURI = 2
  (Optional) Use a different source URI then configured. If provided the upgrade process will use the provided sourceURI instead of the configured sourceURI in the configuration.
message UpgradeResponse
control_v1.proto:76
A upgrade response message.
- ActionStatus status = 1
  Response status.
- string version = 2
  Version that is being upgraded to.
- string error = 3
  Error message when it fails to trigger upgrade.

Action status codes for restart and upgrade response.

Used in: RestartResponse, UpgradeResponse

V1_SUCCESS = 0
Action was successful.
V1_FAILURE = 1
Action failed.

Current status of the application in Elastic Agent.

Used in: StatusResponse

string id = 1
Unique application ID.
string name = 2
Application name.
Status status = 3
Current status.
string message = 4
Current status message.
string payload = 5
Current status payload.

Empty message.

Used as request type in: ElasticAgentControl.Restart, ElasticAgentControl.Status, ElasticAgentControl.Version

(message has no fields)

Status codes for the current state.

Used in: ApplicationStatus, StatusResponse

V1_STARTING = 0
V1_CONFIGURING = 1
V1_HEALTHY = 2
V1_DEGRADED = 3
V1_FAILED = 4
V1_STOPPING = 5
V1_UPGRADING = 6
V1_SROLLBACK = 7

package proto

service ElasticAgentControl

rpc Version (Empty, VersionResponse)

message VersionResponse

string version = 1

string commit = 2

string buildTime = 3

bool snapshot = 4

rpc Status (Empty, StatusResponse)

message StatusResponse

Status status = 1

string message = 2

repeated ApplicationStatus applications = 3

rpc Restart (Empty, RestartResponse)

message RestartResponse

ActionStatus status = 1

string error = 2

rpc Upgrade (UpgradeRequest, UpgradeResponse)

message UpgradeRequest

string version = 1

string sourceURI = 2

message UpgradeResponse

ActionStatus status = 1

string version = 2

string error = 3

enum ActionStatus

V1_SUCCESS = 0

V1_FAILURE = 1

message ApplicationStatus

string id = 1

string name = 2

Status status = 3

string message = 4

string payload = 5

message Empty

enum Status

V1_STARTING = 0

V1_CONFIGURING = 1

V1_HEALTHY = 2

V1_DEGRADED = 3

V1_FAILED = 4

V1_STOPPING = 5

V1_UPGRADING = 6

V1_SROLLBACK = 7