Home
Version 3
Events API

Events API

List Service Instance Update Events (experimental)

GET /v2/events

Fields

Name Description Default Valid Values Example Values
guid The guid of the event.
type The type of the event.
  • app.crash
  • audit.app.update
  • audit.app.create
  • audit.app.delete-request
  • 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
  • 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
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.

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

Request

Headers

Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjl9.jKSnU-eZg6MnaBms6INYKYSbLRj7mSQIcOYX1m7ky6E
Host: example.org
Cookie: 

Route

GET /v2/events?q=type:audit.service_instance.update

Query Parameters

q: type:audit.service_instance.update

cURL

curl "https://api.[your-domain.com]/v2/events?q=type:audit.service_instance.update" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTE5MCIsImVtYWlsIjoiZW1haWwtMTM4QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQxMzczNjl9.jKSnU-eZg6MnaBms6INYKYSbLRj7mSQIcOYX1m7ky6E" \
	-H "Host: example.org" \
	-H "Cookie: "

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 08060873-ef88-4c3c-be81-323ad7de1150
Content-Length: 966
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "cf1915f1-65f2-473d-8d2e-e72dc51ca9a6",
        "url": "/v2/events/cf1915f1-65f2-473d-8d2e-e72dc51ca9a6",
        "created_at": "2015-02-10T01:42:49Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.service_instance.update",
        "actor": "uaa-id-189",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "57eab1b3-1cd1-4836-8d4d-dc34959a326e",
        "actee_type": "service_instance",
        "actee_name": "name-520",
        "timestamp": "2015-02-10T01:42:49Z",
        "metadata": {
          "request": {
            "service_plan_guid": "6342d29b-1de7-4c6b-a574-80b74dac0d24"
          }
        },
        "space_guid": "7686f271-9067-480c-a519-5c759e47d611",
        "organization_guid": "828dab5b-f0bf-4885-b5f3-fb4f4363dcb8"
      }
    }
  ]
}