Home
Version 3
Events API

Events API

List App Stop Events

GET /v2/events

Request

Route

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

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, space_guid, organization_guid
  • 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
order-by Attribute to order results by
  • timestamp
  • id
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.stop

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExMCIsImVtYWlsIjoiZW1haWwtNjlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQ2NjAwODg4N30.WXhc_ZF5hNKwQDQ2VQ80OWZ1b4T5mbyMSDFa0pgdRnE
Host: example.org
Cookie: 

cURL

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

Response

Status

200 OK

Body

Name Description Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.copy-bits
  • audit.app.create
  • audit.app.delete-request
  • audit.app.droplet_mapped
  • audit.app.map-route
  • audit.app.package.create
  • audit.app.package.delete
  • audit.app.package.download
  • audit.app.package.upload
  • audit.app.restage
  • audit.app.ssh-authorized
  • audit.app.ssh-unauthorized
  • audit.app.start
  • audit.app.stop
  • audit.app.unmap-route
  • audit.app.update
  • audit.route.create
  • audit.route.delete-request
  • audit.route.update
  • audit.service.create
  • audit.service.delete
  • audit.service.update
  • audit.service_binding.create
  • audit.service_binding.delete
  • audit.service_broker.create
  • audit.service_broker.delete
  • audit.service_broker.update
  • audit.service_dashboard_client.create
  • audit.service_dashboard_client.delete
  • audit.service_instance.bind_route
  • audit.service_instance.create
  • audit.service_instance.delete
  • audit.service_instance.unbind_route
  • audit.service_instance.update
  • audit.service_key.create
  • audit.service_key.delete
  • audit.service_plan.create
  • audit.service_plan.delete
  • audit.service_plan.update
  • audit.service_plan_visibility.create
  • audit.service_plan_visibility.delete
  • audit.service_plan_visibility.update
  • audit.space.create
  • audit.space.delete-request
  • audit.space.update
  • audit.user_provided_service_instance.create
  • audit.user_provided_service_instance.delete
  • audit.user_provided_service_instance.update
  • app.crash
  • audit.app.update
type The type of the event.
  • audit.app.droplet.create
  • audit.app.droplet.delete
  • audit.app.droplet.download
  • 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.task.cancel
  • audit.app.task.create
  • audit.app.process.crash
actor The GUID of the actor.
actor_type The actor type.
  • service_broker
  • system
  • user
  • v3-process
actor_name The name of the actor.
actee The GUID of the actee.
actee_type The actee type.
  • app
  • route
  • service
  • service_binding
  • service_broker
  • service_dashboard_client
  • service_instance
  • service_key
  • service_plan
  • service_plan_visibility
  • space
  • user_provided_service_instance
  • 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.
{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "1698d26a-39bb-4210-8036-3296ed93fed1",
        "url": "/v2/events/1698d26a-39bb-4210-8036-3296ed93fed1",
        "created_at": "2016-06-08T16:41:27Z",
        "updated_at": "2016-06-08T16:41:26Z"
      },
      "entity": {
        "type": "audit.app.stop",
        "actor": "uaa-id-109",
        "actor_type": "user",
        "actor_name": "user@example.com",
        "actee": "guid-278aa447-6947-4a8b-a4ac-270bf5edec84",
        "actee_type": "v3-app",
        "actee_name": "name-1251",
        "timestamp": "2016-06-08T16:41:27Z",
        "metadata": {

        },
        "space_guid": "4a10b249-1b42-4351-85de-a96ece28191a",
        "organization_guid": "67ee124e-0ad4-4715-9751-1d6ecafb7199"
      }
    }
  ]
}

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 2962cc83-8ede-4928-8bb0-27bbfa20d3c6
Content-Length: 843
X-Content-Type-Options: nosniff