Post an event

post

https://api.cloudzero.com/events/v1/events

When something happens in one of your engineering systems that may have an impact on your cloud costs, submit an Event to the CloudZero API to correlate the Event with your ongoing cloud costs. For example, you can send us an Event every time you do a deployment. CloudZero will then correlate those deployment Events with changing cloud costs to help you understand what is driving said costs in any given period of time.

Body Params

Event to submit to CloudZero

title

string

required

length ≤ 256

Defaults to api-docs-test-event

The title of the event, which will generally be the main string shown in the UI. Must not contain HTML tags or script injection patterns (e.g., <script>, onclick=). Values containing < or > will be rejected with a 400 error. Example: production-feature-deployed

source

string

required

length ≤ 256

Defaults to cloudzero-api-docs

The system from which the event originates. Must not contain HTML tags or script injection patterns. Values containing < or > will be rejected with a 400 error. Example: jenkins

timestamp

string

An ISO date string of when the event occurred. If you do not provide the timestamp, CloudZero will automatically generate the timestamp at the time the event is POSTed. User-provided timestamps are more accurate. Note: must be in UTC Example: 2020-03-03T15:32:44.474670+00:00

filters

object

Filters allow you to scope an event to a specific set of cloud resources. The properties below are commonly used dimensions, but additional key/value pairs are also accepted. Filter values must not contain HTML tags or script injection patterns. NOTE: Currently all events are shown on the Explorer, regardless of filters.

link

string

A link to a page with more information about the event (e.g. a link to the CI/CD job, or a link to the PR.)

Example: http://jenkins.com/builds/production-feature

metadata

object

An optional blob of arbitrary data containing any additional data about the event. Values must not contain HTML tags or script injection patterns (e.g., <script>, onclick=). Example: { 'user': '[email protected]', 'git_sha': '923dd0037a455576561b89c2321ffc36473578c7' }

Headers

Authorization

string

required

Your CloudZero API Key. Note: This is not a bearer token, and should appear in the header as Authorization: <cloudzero-api-key>

Responses

400

Invalid event, make sure your event conforms to the schema

403

Not authorized, make sure you're using a valid API key in the header Authorization

201Event created