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
  • audit.route.create
  • audit.route.update
  • audit.route.delete-request
  • app.crash
  • audit.app.update
type The type of the event.
  • audit.app.droplet.create
  • audit.app.droplet.delete
  • audit.app.process.crash
  • audit.app.process.create
  • audit.app.process.delete
  • audit.app.process.scale
  • audit.app.process.terminate_instance
  • audit.app.process.update
  • audit.app.process.crash
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 (experimental)
  • v3-service-binding (experimental)
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.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MyIsImVtYWlsIjoiZW1haWwtMjc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MTN9.QjRtYEqBKO25R3sqm8Af8Jk8MWD1R_vMZr4UAnAl5h4
Host: example.org
Cookie: 

cURL

curl "https://api.[your-domain.com]/v2/events?q=type:audit.app.start" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTM4MyIsImVtYWlsIjoiZW1haWwtMjc3QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjE5NTg0MTN9.QjRtYEqBKO25R3sqm8Af8Jk8MWD1R_vMZr4UAnAl5h4" \
	-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": "72309140-1371-4495-bedd-9eec2f9b9773",
        "url": "/v2/events/72309140-1371-4495-bedd-9eec2f9b9773",
        "created_at": "2016-04-22T19:33:33Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.app.start",
        "actor": "uaa-id-382",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "guid-8bc27396-0a50-424b-9b30-0d7776eaf893",
        "actee_type": "v3-app",
        "actee_name": "name-1525",
        "timestamp": "2016-04-22T19:33:33Z",
        "metadata": {

        },
        "space_guid": "132194f1-3ee9-4c76-bb99-56df2ca92320",
        "organization_guid": "881b44ab-73d0-4b0e-88bd-1b70399d4b09"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 3a766fe8-cf08-4b84-b4b4-fd870e15b77e
Content-Length: 844
X-Content-Type-Options: nosniff