Home
Version 3
Events API

Events API

List events associated with an App since January 1, 2014

GET /v2/events

Request

Route

GET /v2/events?q=actee:33021049-49b6-4e04-b4da-afc100d322ca&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00

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
q: timestamp>2014-01-01 00:00:00-04:00

Body

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.start
  • audit.app.stop
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • audit.app.ssh-authorized
  • audit.app.ssh-unauthorized
  • 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
  • audit.service_key.create
  • audit.service_key.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
  • v3-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.

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTN9.ja1vQgwHLxr9S2whhjEJjJ95w_cXSpblcu6tkOxfE8w
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events?q=actee:33021049-49b6-4e04-b4da-afc100d322ca&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyMiIsImVtYWlsIjoiZW1haWwtMjI0QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTE0MTM2OTN9.ja1vQgwHLxr9S2whhjEJjJ95w_cXSpblcu6tkOxfE8w" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 3,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "3ccf3a51-43b6-4ee8-8575-376b8a6a1d8d",
        "url": "/v2/events/3ccf3a51-43b6-4ee8-8575-376b8a6a1d8d",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.create",
        "actor": "uaa-id-321",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "33021049-49b6-4e04-b4da-afc100d322ca",
        "actee_type": "app",
        "actee_name": "name-1208",
        "timestamp": "2015-12-22T18:28:13Z",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN",
            "docker_credentials_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "933607d2-80bb-47c8-b557-0022f4d3a63e",
        "organization_guid": "8687ce6b-46c8-4d21-9cc9-4c559cdcb7d8"
      }
    },
    {
      "metadata": {
        "guid": "ebedb33a-2a2e-43d6-9f72-eb4492cfa996",
        "url": "/v2/events/ebedb33a-2a2e-43d6-9f72-eb4492cfa996",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.update",
        "actor": "uaa-id-321",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "33021049-49b6-4e04-b4da-afc100d322ca",
        "actee_type": "app",
        "actee_name": "name-1208",
        "timestamp": "2015-12-22T18:28:13Z",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN",
            "docker_credentials_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "933607d2-80bb-47c8-b557-0022f4d3a63e",
        "organization_guid": "8687ce6b-46c8-4d21-9cc9-4c559cdcb7d8"
      }
    },
    {
      "metadata": {
        "guid": "36eb1b35-8375-4cd9-b81f-ac4af6ebd9fe",
        "url": "/v2/events/36eb1b35-8375-4cd9-b81f-ac4af6ebd9fe",
        "created_at": "2015-12-22T18:28:13Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.delete-request",
        "actor": "uaa-id-321",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "33021049-49b6-4e04-b4da-afc100d322ca",
        "actee_type": "app",
        "actee_name": "name-1208",
        "timestamp": "2015-12-22T18:28:13Z",
        "metadata": {
          "request": {
            "recursive": false
          }
        },
        "space_guid": "933607d2-80bb-47c8-b557-0022f4d3a63e",
        "organization_guid": "8687ce6b-46c8-4d21-9cc9-4c559cdcb7d8"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 
Content-Length: 2900
X-Content-Type-Options: nosniff