Events API

List events associated with an App since January 1, 2014

GET /v2/events

Request

Route

GET /v2/events?q=actee:7a996ab9-276a-44b7-8673-7c83a9515476&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	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.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3ODJ9.0TOfXQeOA3lnzg25saULkbM0Yjr-LP-2j6G_t_0GaVE
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events?q=actee:7a996ab9-276a-44b7-8673-7c83a9515476&q=timestamp%3E2014-01-01+00%3A00%3A00-04%3A00" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE2MyIsImVtYWlsIjoiZW1haWwtMTAyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MzY4Mjk3ODJ9.0TOfXQeOA3lnzg25saULkbM0Yjr-LP-2j6G_t_0GaVE" \
	-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": "e74e1099-029f-42e4-a3c1-bc439cc02464",
        "url": "/v2/events/e74e1099-029f-42e4-a3c1-bc439cc02464",
        "created_at": "2015-07-06T23:23:02Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.create",
        "actor": "uaa-id-162",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "7a996ab9-276a-44b7-8673-7c83a9515476",
        "actee_type": "app",
        "actee_name": "name-819",
        "timestamp": "2015-07-06T23:23:02Z",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN",
            "docker_credentials_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "017ba811-e698-4d49-b873-9ddec92bb3e6",
        "organization_guid": "d9a6cc80-4ff2-4e23-8628-7703affe8b9f"
      }
    },
    {
      "metadata": {
        "guid": "6c3d0631-b22a-411e-b93a-63cf55672532",
        "url": "/v2/events/6c3d0631-b22a-411e-b93a-63cf55672532",
        "created_at": "2015-07-06T23:23:02Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.update",
        "actor": "uaa-id-162",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "7a996ab9-276a-44b7-8673-7c83a9515476",
        "actee_type": "app",
        "actee_name": "name-819",
        "timestamp": "2015-07-06T23:23:02Z",
        "metadata": {
          "request": {
            "name": "new",
            "instances": 1,
            "memory": 84,
            "state": "STOPPED",
            "environment_json": "PRIVATE DATA HIDDEN",
            "docker_credentials_json": "PRIVATE DATA HIDDEN"
          }
        },
        "space_guid": "017ba811-e698-4d49-b873-9ddec92bb3e6",
        "organization_guid": "d9a6cc80-4ff2-4e23-8628-7703affe8b9f"
      }
    },
    {
      "metadata": {
        "guid": "ad8a32b3-ff10-4dd2-8e94-f2d2e91b6be8",
        "url": "/v2/events/ad8a32b3-ff10-4dd2-8e94-f2d2e91b6be8",
        "created_at": "2015-07-06T23:23:02Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.delete-request",
        "actor": "uaa-id-162",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "7a996ab9-276a-44b7-8673-7c83a9515476",
        "actee_type": "app",
        "actee_name": "name-819",
        "timestamp": "2015-07-06T23:23:02Z",
        "metadata": {
          "request": {
            "recursive": false
          }
        },
        "space_guid": "017ba811-e698-4d49-b873-9ddec92bb3e6",
        "organization_guid": "d9a6cc80-4ff2-4e23-8628-7703affe8b9f"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 25c3e6f8-6a4c-4a3e-b795-e5624b3424d5
Content-Length: 2897
X-Content-Type-Options: nosniff