Home
Version 3
Events API

Events API

List App Start Events

GET /v2/events

Request

Route

GET /v2/events?q=type:audit.app.start

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: type:audit.app.start

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.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMCIsImVtYWlsIjoiZW1haWwtOTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDc4MjkzMH0._gAJ765hxdZ8iGDLY8cfFqHEDVv0Rc0VFgSaObS1lYI
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events?q=type:audit.app.start" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzMCIsImVtYWlsIjoiZW1haWwtOTVAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ0NDc4MjkzMH0._gAJ765hxdZ8iGDLY8cfFqHEDVv0Rc0VFgSaObS1lYI" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "de67e168-a7a2-4217-898d-cc7eb007e9ce",
        "url": "/v2/events/de67e168-a7a2-4217-898d-cc7eb007e9ce",
        "created_at": "2015-10-07T00:35:30Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.start",
        "actor": "uaa-id-129",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "guid-451250ef-cd8d-46a2-a22a-7c4b61989ffa",
        "actee_type": "v3-app",
        "actee_name": "name-756",
        "timestamp": "2015-10-07T00:35:30Z",
        "metadata": {

        },
        "space_guid": "2f935e48-d088-4f85-b7d9-4b011e94f000",
        "organization_guid": "2d533870-0254-4750-83de-5d109d70a054"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 23c84b75-14e3-4c08-8bfa-1134b53a4585
Content-Length: 843
X-Content-Type-Options: nosniff