open-consul/website/source/docs/agent/http/event.html.markdown

layout	page_title	sidebar_current	description
docs	Events (HTTP)	docs-agent-http-event	The Event endpoints are used to fire new events and to query the available events

Event HTTP Endpoint

The Event endpoints are used to fire new events and to query the available events.

The following endpoints are supported:

• /v1/event/fire/<name>: Fires a new user event
• /v1/event/list: Lists the most recent events an agent has seen.

/v1/event/fire/<name>

The fire endpoint is used to trigger a new user event. A user event needs a name, provided on the path. The endpoint also supports several optional parameters on the query string.

By default, the agent's local datacenter is used, but another datacenter can be specified using the "?dc=" query parameter.

The fire endpoint expects a PUT request with an optional body. The body contents are opaque to Consul and become the "payload" of the event. Names starting with the "_" prefix should be considered reserved for Consul's internal use.

The ?node=, ?service=, and ?tag= query parameters may optionally be provided. They respectively provide a regular expression to filter by node name, service, and service tags.

The return code is 200 on success, along with a body like:

{
  "ID": "b54fe110-7af5-cafc-d1fb-afc8ba432b1c",
  "Name": "deploy",
  "Payload": null,
  "NodeFilter": "",
  "ServiceFilter": "",
  "TagFilter": "",
  "Version": 1,
  "LTime": 0
}

The ID field uniquely identifies the newly fired event.

/v1/event/list

This endpoint is hit with a GET and returns the most recent events known by the agent. As a consequence of how the event command works, each agent may have a different view of the events. Events are broadcast using the gossip protocol, so they have no global ordering nor do they make a promise of delivery.

Additionally, each node applies the node, service and tag filters locally before storing the event. This means the events at each agent may be different depending on their configuration.

This endpoint allows for filtering on events by name by providing the ?name= query parameter.

To support watches, this endpoint supports blocking queries. However, the semantics of this endpoint are slightly different. Most blocking queries provide a monotonic index and block until a newer index is available. This can be supported as a consequence of the total ordering of the consensus protocol. With gossip, there is no ordering, and instead X-Consul-Index maps to the newest event that matches the query.

In practice, this means the index is only useful when used against a single agent and has no meaning globally. Because Consul defines the index as being opaque, clients should not be expecting a natural ordering either.

Agents only buffer the most recent entries. The current buffer size is 256, but this value could change in the future.

It returns a JSON body like this:

[
  {
    "ID": "b54fe110-7af5-cafc-d1fb-afc8ba432b1c",
    "Name": "deploy",
    "Payload": "MTYwOTAzMA==",
    "NodeFilter": "",
    "ServiceFilter": "",
    "TagFilter": "",
    "Version": 1,
    "LTime": 19
  },
  ...
]