Skip to main content
POST
Sidecar Handshake

Headers

hoop-sidecar-token
string
required

The token returned when the sidecar was created

hoop-sidecar-capabilities
string

Comma-separated served-document features this sidecar decodes, such as review_mode. Absent means a build too old to report.

Body

application/json

The request body resource

version
string
required

Version of the sidecar binary

Example:

"1.0.0"

applied_revision
string

AppliedRevision is the hoop-sidecar-config-revision of the last configuration this sidecar actually took on, which is not necessarily the last one it was served: a document it refused, or one needing a restart, leaves this at the revision still running.

Optional. A sidecar too old to report it, or one that has handled no document yet, sends nothing and is reported as unknown rather than as converged.

Example:

"8f14e45fceea167a5a36dedd4bea2543"

last_outcome
string

LastOutcome is what this sidecar concluded about that configuration: applied, restart, refused, unchanged or retry. It is the only way to tell a sidecar enforcing the current rules from one that refused them and kept the old ones while still handshaking on time.

Optional, for the same reason as AppliedRevision.

Example:

"applied"

Response

OK

The response is of type object.