Home
Version 3
Events API

Events API

List all Events

GET /v2/events

Request

Route

GET /v2/events

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

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.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNSIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5ODZ9.GhszxleBC_TeFbGf9vewqA2kc3K0oI9Gp_mGi4lKvDI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMwNSIsImVtYWlsIjoiZW1haWwtMjA1QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTMzMTA5ODZ9.GhszxleBC_TeFbGf9vewqA2kc3K0oI9Gp_mGi4lKvDI" \
	-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": "fadb4138-13b9-4e37-b86d-2f41f6e7c784",
        "url": "/v2/events/fadb4138-13b9-4e37-b86d-2f41f6e7c784",
        "created_at": "2016-01-13T17:29:46Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1700",
        "actor": "guid-d91c6888-7259-4f50-81c9-0f6576b68369",
        "actor_type": "name-1701",
        "actor_name": "name-1702",
        "actee": "guid-9f8d6ca9-6805-4090-9ff8-1f1201a9baee",
        "actee_type": "name-1703",
        "actee_name": "name-1704",
        "timestamp": "2016-01-13T17:29:46Z",
        "metadata": {

        },
        "space_guid": "9ad0f152-7e85-4276-a097-588629c74c55",
        "organization_guid": "f3e2606a-f17d-402a-b143-3734759349dd"
      }
    },
    {
      "metadata": {
        "guid": "f68e127d-6388-43a2-aff3-0c5021c303de",
        "url": "/v2/events/f68e127d-6388-43a2-aff3-0c5021c303de",
        "created_at": "2016-01-13T17:29:46Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1708",
        "actor": "guid-75f0e554-1ab5-4fb6-8eb6-0ccca6fe77d8",
        "actor_type": "name-1709",
        "actor_name": "name-1710",
        "actee": "guid-f37a932e-d99c-473b-9380-99cdedb2161d",
        "actee_type": "name-1711",
        "actee_name": "name-1712",
        "timestamp": "2016-01-13T17:29:46Z",
        "metadata": {

        },
        "space_guid": "62f2ca15-a5de-4c0e-b0e1-3e4d9c43a428",
        "organization_guid": "1e811738-8d08-449b-ade8-c5ecb58c8883"
      }
    },
    {
      "metadata": {
        "guid": "1b010120-704f-4e1b-9be0-5ed98583e0ef",
        "url": "/v2/events/1b010120-704f-4e1b-9be0-5ed98583e0ef",
        "created_at": "2016-01-13T17:29:46Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1716",
        "actor": "guid-48b3cf0a-3e46-4d86-b099-022b520138ed",
        "actor_type": "name-1717",
        "actor_name": "name-1718",
        "actee": "guid-daae6a8a-6115-4d42-a9ed-56f68c6e76ca",
        "actee_type": "name-1719",
        "actee_name": "name-1720",
        "timestamp": "2016-01-13T17:29:46Z",
        "metadata": {

        },
        "space_guid": "03ccd002-8cb8-488b-ad87-c6bc956049d3",
        "organization_guid": "822dedf1-6afc-4c20-8a17-74dfff9d05b3"
      }
    }
  ]
}

Headers

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