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=0fb01954-8510-409f-b48d-4539c20b018a


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: 0fb01954-8510-409f-b48d-4539c20b018a


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.
serivce_label The name of the service.


Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNSIsImVtYWlsIjoiZW1haWwtODZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc4MH0.8O4xnDIUzfl2ppyQdKwG5SIpiXfhJUm7wqtpqpV6UI8
Host: example.org


curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=0fb01954-8510-409f-b48d-4539c20b018a" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTEzNSIsImVtYWlsIjoiZW1haWwtODZAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQzNjgyOTc4MH0.8O4xnDIUzfl2ppyQdKwG5SIpiXfhJUm7wqtpqpV6UI8" \
	-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=0fb01954-8510-409f-b48d-4539c20b018a&order-direction=asc&page=2&results-per-page=1",
  "resources": [
      "metadata": {
        "guid": "9bb286b6-3244-4c9e-b72d-4c12abaf41f3",
        "url": "/v2/service_usage_events/9bb286b6-3244-4c9e-b72d-4c12abaf41f3",
        "created_at": "2015-07-06T23:23:00Z"
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-3206ce21-73ef-4208-a6f0-45e5c54b5afa",
        "space_guid": "guid-da3db891-d3f2-4a33-9b75-4c54b8bb0ba4",
        "space_name": "name-417",
        "service_instance_guid": "guid-2e0184cd-05c1-4308-98dc-92fc81bd4c1a",
        "service_instance_name": "name-418",
        "service_instance_type": "type-2",
        "service_plan_guid": "guid-08772387-32e6-4df4-9297-b0ec72bceeab",
        "service_plan_name": "name-419",
        "service_guid": "guid-8c538cf7-bca0-40a1-a703-eda2d1d43199",
        "service_label": "label-21"


Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 5d5bf91a-071f-4133-9a20-6064583eac29
Content-Length: 1050
X-Content-Type-Options: nosniff