Home
Version 3
Events API

Events API

List Service Instance Create 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.eyJ1c2VyX2lkIjoidWFhLWlkLTE4MSIsImVtYWlsIjoiZW1haWwtMTI2QHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0MjQ0NzE2OTR9.Qd-gCnYWwa1Pssyvsb6atnBC1TTQni9l45GJvdE7yz4
Host: example.org
Cookie: 

Route

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

Query Parameters

q: type:audit.service_instance.create

cURL

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

Response

Headers

Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 7c06caec-ab32-4848-b36e-03e170280a3b
Content-Length: 1064
X-Content-Type-Options: nosniff

Status

200 OK

Body

{
  "total_results": 1,
  "total_pages": 1,
  "prev_url": null,
  "next_url": null,
  "resources": [
    {
      "metadata": {
        "guid": "a6bea6d2-2126-489e-b3c2-38157f1ca031",
        "url": "/v2/events/a6bea6d2-2126-489e-b3c2-38157f1ca031",
        "created_at": "2015-02-13T22:34:54Z",
        "updated_at": null
      },
      "entity": {
        "type": "audit.service_instance.create",
        "actor": "uaa-id-180",
        "actor_type": "user",
        "actor_name": "user@email.com",
        "actee": "5d46dfca-fe1a-4ffb-af28-3dc7462ad142",
        "actee_type": "service_instance",
        "actee_name": "name-889",
        "timestamp": "2015-02-13T22:34:54Z",
        "metadata": {
          "request": {
            "name": "name-889",
            "service_plan_guid": "34a43222-329e-47b5-8c06-be7f6907101c",
            "space_guid": "e698697f-ddad-4335-b9f6-be46f00f6a75"
          }
        },
        "space_guid": "e698697f-ddad-4335-b9f6-be46f00f6a75",
        "organization_guid": "00790cfc-389c-4ae8-8cef-d40786ef6c95"
      }
    }
  ]
}