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=b3524966-8970-410e-abc2-17d14dc61fbe


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
  • 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: b3524966-8970-410e-abc2-17d14dc61fbe


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.eyJ1c2VyX2lkIjoidWFhLWlkLTExOSIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNTk0ODY2NH0.3ijTmEgxkrPQeISYUq6AVEOuWiClHEuxfD58uNEt8yA
Host: example.org


curl "https://api.[your-domain.com]/v2/service_usage_events?results-per-page=1&after_guid=b3524966-8970-410e-abc2-17d14dc61fbe" -X GET \
	-H "Authorization: bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoidWFhLWlkLTExOSIsImVtYWlsIjoiZW1haWwtODlAc29tZWRvbWFpbi5jb20iLCJzY29wZSI6WyJjbG91ZF9jb250cm9sbGVyLmFkbWluIl0sImF1ZCI6WyJjbG91ZF9jb250cm9sbGVyIl0sImV4cCI6MTQyNTk0ODY2NH0.3ijTmEgxkrPQeISYUq6AVEOuWiClHEuxfD58uNEt8yA" \
	-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=b3524966-8970-410e-abc2-17d14dc61fbe&order-direction=asc&page=2&results-per-page=1",
  "resources": [
      "metadata": {
        "guid": "bef255b1-bf97-4fd4-b3aa-354d104a806b",
        "url": "/v2/service_usage_events/bef255b1-bf97-4fd4-b3aa-354d104a806b",
        "created_at": "2015-03-03T00:51:04Z"
      "entity": {
        "state": "CREATED",
        "org_guid": "guid-805413ce-ab27-4101-a526-e37ea408dea7",
        "space_guid": "guid-c8c811ab-e2a7-4ed1-99a0-9e26a92d4b66",
        "space_name": "name-1032",
        "service_instance_guid": "guid-5b40b142-78c1-47b2-ac24-91fafbe0a1b4",
        "service_instance_name": "name-1033",
        "service_instance_type": "type-2",
        "service_plan_guid": "guid-37651083-31e7-45cb-bd88-a864a7f3fc7f",
        "service_plan_name": "name-1034",
        "service_guid": "guid-4caace84-1848-41e3-b50d-4ba226f47b83",
        "service_label": "label-32"


Content-Type: application/json;charset=utf-8
X-VCAP-Request-ID: 795fdce1-bcf0-40a4-a88a-8faa7717e06a
Content-Length: 1053
X-Content-Type-Options: nosniff