OFoffice-of-national-statistics
Private

Add an event to an instance

Add a new event into an instance. Events can be for information or error messages. Each event must contain a type of event (Info or Error), a message to explain the event, time of the event and finally the message offset in kafka

post/instances/{instance_id}/events

Request

  • Base URL
    https://api.beta.ons.gov.uk/v1
  • Auth
    API key in header Authorization

Path parameters

instance_idstring required

A unique id for an instance

Headers

If-Matchstring

Filter resource version, as returned by a previous ETag, to be validated; or '*' to skip the version check

Request body

messagestring

A description of the event

message_offsetstring

The kafka message offset (Used to locate the kafka message)

timestring

The time of the event in ISO 8601 format

typestring

The type of event, this can be;

  • Info - for an information event
  • Error - for an error event

Response

The event was added to the instance

Changes

No recorded changes to this operation across all 1 revision of this API.