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.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MiIsImVtYWlsIjoiZW1haWwtMjAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MjR9.U2EFGigPDKunnBXYh8udYlssDrVM6odOMtAKuhkmqb8
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTI2MiIsImVtYWlsIjoiZW1haWwtMjAwQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NTQ0NTE2MjR9.U2EFGigPDKunnBXYh8udYlssDrVM6odOMtAKuhkmqb8" \
	-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": "72ac79b9-d4ca-4632-9ab1-72bb6c87ec8a",
        "url": "/v2/events/72ac79b9-d4ca-4632-9ab1-72bb6c87ec8a",
        "created_at": "2016-01-26T22:20:24Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1126",
        "actor": "guid-9afc5a93-9b4e-4477-9412-3a1aaa72b75d",
        "actor_type": "name-1127",
        "actor_name": "name-1128",
        "actee": "guid-ffe7432e-0422-4c41-85f3-7d5ff986b281",
        "actee_type": "name-1129",
        "actee_name": "name-1130",
        "timestamp": "2016-01-26T22:20:24Z",
        "metadata": {

        },
        "space_guid": "554e6bb6-dcb1-4c4c-baf7-287145afcafe",
        "organization_guid": "f6f4c54d-5aa7-4ff6-bcf4-f3c1b4e83c67"
      }
    },
    {
      "metadata": {
        "guid": "85a91d96-5e33-46a8-aa85-a56d9715602c",
        "url": "/v2/events/85a91d96-5e33-46a8-aa85-a56d9715602c",
        "created_at": "2016-01-26T22:20:24Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1134",
        "actor": "guid-2a6f613e-1182-4914-a55e-16fdc12b02a0",
        "actor_type": "name-1135",
        "actor_name": "name-1136",
        "actee": "guid-b93cf6a3-7919-4a1d-a81d-441d58dad3a0",
        "actee_type": "name-1137",
        "actee_name": "name-1138",
        "timestamp": "2016-01-26T22:20:24Z",
        "metadata": {

        },
        "space_guid": "fb0e583a-518d-4939-82a8-2fb855f79d2e",
        "organization_guid": "ed719e0b-24cc-4ca1-83a3-c3bbee5feb0d"
      }
    },
    {
      "metadata": {
        "guid": "bdb3a71d-a9cd-4368-8159-388493b1258a",
        "url": "/v2/events/bdb3a71d-a9cd-4368-8159-388493b1258a",
        "created_at": "2016-01-26T22:20:24Z",
        "updated_at": null
      },
      "entity": {
        "type": "name-1142",
        "actor": "guid-bb7d9118-55e2-4a58-8abc-7967d9ec465b",
        "actor_type": "name-1143",
        "actor_name": "name-1144",
        "actee": "guid-a6055d46-0ec8-4e58-83da-84652ff400d7",
        "actee_type": "name-1145",
        "actee_name": "name-1146",
        "timestamp": "2016-01-26T22:20:24Z",
        "metadata": {

        },
        "space_guid": "3f9603b9-0da2-4393-9c6e-797a500562fa",
        "organization_guid": "70b34256-d7ea-4562-9073-30e816da5bca"
      }
    }
  ]
}

Headers

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