Version 3
Service Usage Events API

Service Usage Events API

List Service Usage Events

GET /v2/service_usage_events

Events are sorted by internal database IDs. This order may differ from created_at. Events close to the current time should not be processed because other events may still have open transactions that will change their order in the results.



GET /v2/service_usage_events?results-per-page=1&after_guid=0947a8ec-2b8b-42d6-98a4-8708f7f2ce9f


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: service_instance_type, service_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
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
after_guid Restrict results to Service Usage Events after the one with the given guid
results-per-page: 1
after_guid: 0947a8ec-2b8b-42d6-98a4-8708f7f2ce9f


Name Description Default Valid Values Example Values
guid The guid of the event.
state The desired state of the service.
org_guid The GUID of the organization.
space_guid The GUID of the space.
space_name The name of the space.
service_instance_guid The GUID of the service instance.
service_instance_name The name of the service instance.
service_instance_type The type of the service instance.
  • managed_service_instance
  • user_provided_service_instance
service_plan_guid The GUID for the service plan.
service_plan_name The name for the service plan.
service_guid The GUID of the service.
created_at The timestamp of the event creation.
service_label The name of the service.
service_broker_name The name of the service broker.
service_broker_guid The GUID of the service broker.


Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNyIsImVtYWlsIjoiZW1haWwtMjIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTl9.MiS5o1X6WOFWMJFPoooRY90k-lNYcMezqDJ5dYWrjVw
Host: example.org


curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=0947a8ec-2b8b-42d6-98a4-8708f7f2ce9f" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTMyNyIsImVtYWlsIjoiZW1haWwtMjIyQHNvbWVkb21haW4uY29tIiwic2NvcGUiOlsiY2xvdWRfY29udHJvbGxlci5hZG1pbiJdLCJhdWQiOlsiY2xvdWRfY29udHJvbGxlciJdLCJleHAiOjE0NjYwMDg4OTl9.MiS5o1X6WOFWMJFPoooRY90k-lNYcMezqDJ5dYWrjVw" \
	-H "Host: example.org" \
	-H "Cookie: "



200 OK


  "total_results": 2,
  "total_pages": 2,
  "prev_url": null,
  "next_url": "/v2/service_usage_events?after_guid=0947a8ec-2b8b-42d6-98a4-8708f7f2ce9f&order-direction=asc&page=2&results-per-page=1",
  "resources": [
      "metadata": {
        "guid": "985c09c5-bf5a-44eb-a260-41c532dc0f1d",
        "url": "/v2/service_usage_events/985c09c5-bf5a-44eb-a260-41c532dc0f1d",
        "created_at": "2016-06-08T16:41:39Z"
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-396a8cb9-5524-4a2b-8e9e-2bfc70edb58d",
        "space_guid": "guid-be1f6fe3-e63a-41a3-b196-3fc084022823",
        "space_name": "name-1981",
        "service_instance_guid": "guid-f93250f7-7ef5-4b02-8d33-353919ce8358",
        "service_instance_name": "name-1982",
        "service_instance_type": "type-5",
        "service_plan_guid": "guid-e9d2d5a0-69a6-46ef-bac5-43f3ed177614",
        "service_plan_name": "name-1983",
        "service_guid": "guid-34916716-31d7-40c1-9afd-f312996c9654",
        "service_label": "label-64",
        "service_broker_name": "name-2929",
        "service_broker_guid": "guid-7cc11646-bf38-4f4e-b6e0-9581916a74d9"


Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 9b772afb-80e0-4076-9665-b6e73972bfb6
Content-Length: 1053
X-Content-Type-Options: nosniff