Event

Events are changes occurring in Crunchy Bridge which are captured when certain actions are performed which are considered to be worth auditing. For example, when an account creates a cluster, an event is captured with a kind of cluster.created. In general, actions which cause mutable changes are captured as events whereas read-only actions are not.

Events apply to another type of API resource (like a cluster or network), and a representation of that API resource at the time an event occurred on it is captured in an event's data field. This means that to a certain degree, events on a resource can be walked back to see historical representations of a captured resource, although no API compatibility is guaranteed on captured data.

Events are retained for 90 days, after which they are deleted automatically.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

List events

List events for an account, cluster, or team.

With no query parameters, events for which the authenticated account is the "actor" are returned, meaning events which were captured due to actions taken by the account. When cluster_id is specified, events pertaining to any actions that occurred on that cluster are returned instead. When team_id is specified, events taken by any member of that team are returned instead. Only one of these filters can be specified.

This endpoint's pagination may be ordered through the order_field parameter by id only.

GET /events

Request

Query parameters

Name	Type	Description
`cluster_id`	`string`	The cluster ID for which to retrieve events.
`cursor`	`string`	Return only items starting after this cursor ID. When paginating, pass the value of `next_cursor` from the last page into this field to get the next one. Cursor values depend on the field in `order_field`. Cursors will often be the primary IDs of object, but when ordering on another field like `name`, they'll be names (or another value) instead.
`delay`	`integer`	Duration to delay the event stream by. This option helps to hedge against the possibility that events may be read out of order as previously created events aren't yet visible in the event stream because the transaction that created them as not yet committed. Recommended value is `10s` (bringing the probability of missed events down to very close to zero), and an extremely conservative value would be `30s` (making missed events due to ordering problems almost impossible).
`kind`	`array`	Kind to filter returned list of events on. For example, a value of `cluster.created` would return only cluster created events. This parameter maybe be specified multiple times to allow multiple event kinds.
`limit`	`integer`	The maximum number of items to return on the page. Defaults to `100` with a minimum of `1` and a maximum of `200`.
`order`	`string`	The order of pagination. `asc` for ascending or `desc` for descending. Defaults to `asc`. Enum `asc`, or `desc`.
`order_field`	`string`	The name of the field on which to paginate like `id` or `name`. Supported fields are specific to each endpoint, and it's not possible to specify any arbitrary name. See the documentation for each specific list endpoint to see which fields it supports. Defaults to `id` for most resources. Enum `id`.
`team_id`	`string`	The team ID for which to retrieve events.

cURL example

curl -X GET https://api.crunchybridge.com/events
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Response for listing events.

Content type: application/json

Name	Nullable	Type	Description
`events`		`array` of `array`	List of events for this page.
`has_more`		`boolean`	Indicates whether or not there are more resources to page through in the collection.
`next_cursor`	✔	`string`	A cursor value to pass to the endpoint to get the next page.

Example

{
    "events": [
        {
            "actor_email": null,
            "actor_id": "qvcw4hylovgyzbwzp53bmmlhga",
            "actor_ip": "73.70.33.3",
            "cluster_id": "rvf73a77ozfsvcttryebfrnlem",
            "created_at": "2021-07-11T01:02:03Z",
            "data": {
                "cidr4": "1.2.3.4/24",
                "id": "p56biajnfvgjhftvqs7lqymspe",
                "name": "crunchy-production-network",
                "provider_id": "aws",
                "region_id": "us-west-2",
                "team_id": "eaevtjiudzeq7bsqbbpiscund4"
            },
            "description": "[email protected] updated network `p56biajnfvgjhftvqs7lqymspe`.",
            "id": "klkvpx5enfdilaehwhvnmcfoiy",
            "kind": "network.created",
            "object_id": "p56biajnfvgjhftvqs7lqymspe",
            "object_kind": "network",
            "previous_properties": null,
            "request_id": "27a532f4-5bc8-4810-b602-88475a93167c",
            "team_id": "eaevtjiudzeq7bsqbbpiscund4"
        }
    ],
    "has_more": false,
    "next_cursor": null
}

Get event

Get a specific event.

GET /events/{event_id}