Home
Version 3
Events API

Events API

List events associated with an App since January 1, 2014

GET /v2/events

Fields

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • audit.space.create
  • audit.space.update
  • audit.space.delete-request
  • audit.service_broker.create
  • audit.service_broker.update
  • audit.service_broker.delete
  • audit.service.create
  • audit.service.update
  • audit.service.delete
  • audit.service_plan.create
  • audit.service_plan.update
  • audit.service_plan.delete
  • audit.service_plan_visibility.create
  • audit.service_plan_visibility.update
  • audit.service_plan_visibility.delete
  • audit.service_dashboard_client.create
  • audit.service_dashboard_client.delete
  • audit.service_instance.create
  • audit.service_instance.update
  • audit.service_instance.delete
  • audit.user_provided_service_instance.create
  • audit.user_provided_service_instance.update
  • audit.user_provided_service_instance.delete
  • audit.service_binding.create
  • audit.service_binding.delete
  • app.crash
  • audit.app.update
actor The GUID of the actor.
actor_type The actor type.
  • user
  • app
actor_name The name of the actor.
actee The GUID of the actee.
actee_type The actee type.
  • space
  • app
actee_name The name of the actee.
timestamp The event creation time.
metadata The additional information about event. {}
space_guid The guid of the associated space.
organization_guid The guid of the associated organization.

Parameters

Name Description Valid Values Example Values
q Parameters used to filter the result set.
Format queries as <filter><op><value>
Valid ops: : >= <= < > IN
Valid filters: timestamp, type, actee
  • q=filter:value
  • q=filter>value
  • q=filter IN a,b,c
page Page of results to fetch
results-per-page Number of results per page
order-direction Order of the results: asc (default) or desc
inline-relations-depth 0 - don't inline any relations and return URLs. Otherwise, inline to depth N.
orphan-relations 0 - de-duplicate object entries in response
exclude-relations comma-delimited list of relations to drop from response
include-relations comma-delimited list of the only relations to include in response

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MCIsImVtYWlsIjoiZW1haWwtMTAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1Mzh9.jcSRbEkc7KonQnqr98eQw5JDQiU8rwhB75E1-uoUXNs
Host: example.org
Cookie: 

Route

GET /v2/events?q=actee:78606d8d-20d0-4eda-b481-cef7ef5d3914&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00

Query Parameters

q: timestamp>2014-01-01 00:00:00-04:00

cURL

curl "https://api.[your-domain.com]/v2/events?q=actee:78606d8d-20d0-4eda-b481-cef7ef5d3914&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE0MCIsImVtYWlsIjoiZW1haWwtMTAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjIzMjM1Mzh9.jcSRbEkc7KonQnqr98eQw5JDQiU8rwhB75E1-uoUXNs" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9c3b8585-f885-4331-99ad-2f72c9bc568e
Content-Length: 2797
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1e98c65d-15c2-445f-8829-7f6248fd37d3",
        "url": "/v2/events/1e98c65d-15c2-445f-8829-7f6248fd37d3",
        "created_at": "2015-01-20T01:52:18+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.create",
        "actor": "uaa-id-139",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "78606d8d-20d0-4eda-b481-cef7ef5d3914",
        "actee_type": "app",
        "actee_name": "name-794",
        "timestamp": "2015-01-20T01:52:18+00:00",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "f97e908c-1bd1-4934-881a-3e19fa024ff0",
        "organization_guid": "6858be2c-8d19-494e-aae0-7352d6b764d0"
      }
    },
    {
      "metadata": {
        "guid": "caa7587a-87d7-4527-8eb5-0738e81b54ab",
        "url": "/v2/events/caa7587a-87d7-4527-8eb5-0738e81b54ab",
        "created_at": "2015-01-20T01:52:18+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.update",
        "actor": "uaa-id-139",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "78606d8d-20d0-4eda-b481-cef7ef5d3914",
        "actee_type": "app",
        "actee_name": "name-794",
        "timestamp": "2015-01-20T01:52:18+00:00",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "f97e908c-1bd1-4934-881a-3e19fa024ff0",
        "organization_guid": "6858be2c-8d19-494e-aae0-7352d6b764d0"
      }
    },
    {
      "metadata": {
        "guid": "29c97428-cb4e-4c0c-8326-e58628ba375b",
        "url": "/v2/events/29c97428-cb4e-4c0c-8326-e58628ba375b",
        "created_at": "2015-01-20T01:52:18+00:00",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.delete-request",
        "actor": "uaa-id-139",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "78606d8d-20d0-4eda-b481-cef7ef5d3914",
        "actee_type": "app",
        "actee_name": "name-794",
        "timestamp": "2015-01-20T01:52:18+00:00",
        "metadata": {
          "request": {
            "recursive": false
          }
        },
        "space_guid": "f97e908c-1bd1-4934-881a-3e19fa024ff0",
        "organization_guid": "6858be2c-8d19-494e-aae0-7352d6b764d0"
      }
    }
  ]
}