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.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NyIsImVtYWlsIjoiZW1haWwtMjM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MTR9.zafzzB3szzWSzto_IjBvDpmuWvpuHfil0QNqdyM60m0
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM0NyIsImVtYWlsIjoiZW1haWwtMjM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NDE2NjI2MTR9.zafzzB3szzWSzto_IjBvDpmuWvpuHfil0QNqdyM60m0" \
	-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": "dc668017-6770-4013-baf9-ad6635efe3f9",
        "url": "/v2/events/dc668017-6770-4013-baf9-ad6635efe3f9",
        "created_at": "2015-08-31T21:50:14Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-2074",
        "actor": "guid-94e60f4f-0f5e-480f-9d62-68991b46fe87",
        "actor_type": "name-2075",
        "actor_name": "name-2076",
        "actee": "guid-1a959dcb-3ec7-4762-9abe-c6ee1f939952",
        "actee_type": "name-2077",
        "actee_name": "name-2078",
        "timestamp": "2015-08-31T21:50:14Z",
        "metadata": {

        },
        "space_guid": "e62ab490-a65b-4e18-9f28-98df0c9c6a33",
        "organization_guid": "2e232ffc-4747-4a8d-a0c3-bb5cf50ff0e2"
      }
    },
    {
      "metadata": {
        "guid": "d3eee5a8-9adb-400a-a8d2-74073e94672b",
        "url": "/v2/events/d3eee5a8-9adb-400a-a8d2-74073e94672b",
        "created_at": "2015-08-31T21:50:14Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-2082",
        "actor": "guid-464bb915-3089-4c0f-a6bb-8c24c30355fe",
        "actor_type": "name-2083",
        "actor_name": "name-2084",
        "actee": "guid-2fa1aa13-0466-448c-9698-d3908a8b1187",
        "actee_type": "name-2085",
        "actee_name": "name-2086",
        "timestamp": "2015-08-31T21:50:14Z",
        "metadata": {

        },
        "space_guid": "7a327d69-c3c5-4046-9ecd-78f4e3b94378",
        "organization_guid": "c2dbf7e2-4c04-46c5-abe7-0e1f99d2d5e7"
      }
    },
    {
      "metadata": {
        "guid": "eae572c8-8d70-46d0-a94c-4b73e6f99140",
        "url": "/v2/events/eae572c8-8d70-46d0-a94c-4b73e6f99140",
        "created_at": "2015-08-31T21:50:14Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-2090",
        "actor": "guid-d6704901-c89e-40f0-8985-891f40669235",
        "actor_type": "name-2091",
        "actor_name": "name-2092",
        "actee": "guid-e5a153ba-cf17-4b53-a2c1-6578c310bc9b",
        "actee_type": "name-2093",
        "actee_name": "name-2094",
        "timestamp": "2015-08-31T21:50:14Z",
        "metadata": {

        },
        "space_guid": "e09b30b2-06be-49b8-840d-56e85e24eccf",
        "organization_guid": "2a0d5c7c-6f7f-4817-9044-41b64dac3f5e"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: cf5e4118-a598-470e-be4b-f5403031de1c
Content-Length: 2400
X-Content-Type-Options: nosniff